API Information

The API module is an additional module that can be added to your Fast-Weigh Subscription. Please contact our Support team at 865-219-2980 or support@tacinsight, or review our Additional Modules for more 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.

Basic Authentication has been deprecated.

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

Endpoint: https://graphql.fast-weigh.com

Authentication: [ API Key ] via [ bearer token ]

Hitting the GQL API

To hit the api you can use a generated API Key from the API Info page in the Portal as a Bearer Token

headers:

Authorization: "Bearer <api-key>"

Schema & Model Explorer:

To view the GraphQL Schema, simply head to the endpoint directly: https://graphql.fast-weigh.com. This will take you to a web page where you can explore all the available query and mutation models.

GQL Schema Page

REST API

The REST API generally handles CREATE and UPDATE calls.

The OpenAPI/Swagger docs can be found here:


Overview
Authentication
Tooling
Data Queries
Custom Reporting
GraphQL
REST API

Last updated