API Information
API Keys
API Keys are available to generate, view, and revoke from the main API menu screen.
To generate a new API Key, click the +New Key button and enter the users information, their Role, select their their Read/Write Permissions, and any note necessary information in the Comment in the new window, the click Update.
The columns and fields above available display the following information:
Owner: The user using the generated key.
Key: The generated key.
Clipboard Copy: Allows a single click to copy the key.
Permissions: The users permissions related to Read or Write access.
Role: The users role as a Customer or Hauler
Comment: A note to associate or describe the current use of the key.
Revoked: A Yes/No statement if they key is currently in use by the user.
Authentication
The Fast-Weigh REST & GraphQL API services use token-based authentication with a custom x-api-key HTTP header record. The token should be included with every call.
We have transitioned from using Basic Authentication with username/password credentials to token-based authentication. Existing integrations will continue to work, but please note that Basic Authentication has been deprecated.
GraphQL
Your endpoint:
You can find your endpoint listed on the API Info page under the settings gear of the Fast-Weigh Web Portal.
Don't see API Info on your web portal?
You may not be an admin of your Fast-Weigh account. Check with a known admin to see if they can set up this key.
Your company's account may not have this enabled. If this is the case you will need to contact your sales or onboarding rep to get it enabled.
The endpoint should look something like this:
API schema explorer:
Your credentials will allow you to use the Insomnia tool to build queries. There, you can dive into the data model docs as well as test queries with the live editor.
REST API
The REST API generally handles CREATE and UPDATE calls.
The OpenAPI/Swagger docs can be found here:
Useful Reference Links
Last updated