LogoLogo
Web PortalContact Support
  • Fast-Weigh Knowledge Base
  • Tutorials
    • Tutorials Overview
    • Logging in for the First Time
    • Navigating the Web Portal
    • Using the Ticket Query
    • Generating Reports
    • Using the Ticketing App
  • How To Guides
    • How To Guides Overview
    • How to Create New Records
      • Creating New Web Portal Users
      • Creating Tax Codes
      • Creating Billing Terms and Modes
      • Creating a New Customer
      • Creating a New Product
      • Creating a New Pricing Template
      • Creating a New Truck
      • Creating a New Hauler
      • Creating New Orders
      • Creating Invoices
      • Creating Payments
      • Creating Statements
      • Creating Hauler Pay Statement
      • Creating a New Region
      • Creating a New Location
      • Creating a New Yard
    • How to Update Pricing
      • Changing Order Product Pricing
      • Bulk Updating Open Order Pricing
    • How to Import Tickets
    • How to Edit Tickets
      • Edit via Ticket Query
      • Edit via Ticket Bulk Edit
    • How to Edit an Invoice
      • Charge & Cash Pay Types
    • How to Track Inventory
  • References
    • New Pricing Tools
    • References Overview
    • Web Portal
      • Home
      • Load-Out
        • Dashboard
        • In-Yard
        • History
      • Tickets
        • Ticket Query
        • Delivery Query
        • Ticket Entry
        • Ticket Import
        • Ticket Bulk Edit
      • Quotes
        • Dashboard
        • Quotes
        • Projects
      • Orders
        • Orders
        • Status Update
        • Jobs & Phases
        • Haul Zones
      • Inventory
        • Inventory
        • Dashboard
      • Trucks
        • Assignment
        • Trucks
        • Haulers
        • Truck Bulk Edit
      • Dispatch
        • Requests
          • Dispatching Ticket Types
        • Drivers
        • Live Tracking
        • Tracking Query
        • Request Import
      • Billing/AR
        • Billing
        • Balance Dashboard
        • New Payment
        • Invoice / Payment Query
        • Payment Export
        • Customer Credit
      • Hauler Pay
        • Truck Adjustments
        • Statements
        • Setup
      • Reporting
        • Running Reports
          • Default Reports
        • Scheduled Reports
        • Analytics
        • Custom Reports
      • Resources
        • Customer
        • Products
        • Locations
        • Billing
          • Tax Codes
          • Pay Terms
          • Price Adjustments
          • Freight Matrix
          • Ship To
          • Invoice Adjustment Types
          • Customer Payment Information
          • Pay To User Assignment
        • Truck Types
        • Salespeople
        • Inspectors
      • Account and Administration
        • User Administration
        • Portal Settings
        • User Defined Fields
        • Devices
        • API Information
        • Import Format
        • Accounting Periods
        • Email Bounce Report
        • Related Accounts
      • Roles And Responsibilities
    • Ticketing App
      • Setup
      • Application
        • Ticketing
        • Trucks
        • Customers
        • Orders
        • Reports
        • History
        • Portal
        • Settings
    • New Ticketing App
      • Setup
        • Logging In and Device Setup
      • Application
        • Server Settings
          • Manage Devices
        • Lanes & Ticketing
        • Dashboard
        • Trucks
        • In-Yard
        • Customers
        • Orders
        • Requests
        • Payments
        • History
    • Mobile App
      • Setup
        • Mobile Ticketing App
        • Mobile Dispatching App
        • Mobile Printer Setup
      • Ticketing Mode
      • Haul Mode
      • POD Mode
      • Printing
        • Star Micronics
    • Management App
      • Setup
      • Application
    • API Documentation
    • GraphQL Documentation
      • Reporting with GraphQL
    • Accounting Interfaces
      • Quickbooks Online
      • Quickbooks Desktop
      • Spectrum
      • Vista Viewpoint
      • Sage
      • Net Suite
    • Integrations
      • Avalara
      • HaulHub
      • Fast-Weigh Ticket Integrator
    • Hardware
      • Scale House Check List
      • IP Cameras
      • Moxa NPort 5110
      • Web Switch
      • TagMaster CT45
      • External IP Addresses
      • Tegaur Kiosk
      • I&E Kiosk (Legacy)
      • Bluetooth Printers
    • Loader App
      • Setup
  • FAQs and Best Practices
    • Frequently Asked Questions
      • Can I integrate Fast-Weigh with my Accounting Software?
      • What is Fast-Weigh’s NTEP CC #?
      • Can I import ticket data via CSV?
      • Does the web portal adjust based on Time Zones?
      • Why does changing the pricing template not update my orders?
      • Can I connect cameras to the ticketing app?
      • Can I connect my scale to the ticketing app?
      • What are the required computer specs to run Fast-Weigh
      • How do I get a custom report created?
      • Why does cash ticket pricing not behave like charge tickets?
      • Why does my E-Ticket look different than my archived ticket?
      • Can I export any of my data?
      • How do I fix an unsynced record?
      • How do I reset my password?
      • Where can I submit a feature request?
      • Does every customer need an order?
      • Do Ticket Numbers have to be unique?
      • Can Fast-Weigh do inbound ticketing?
      • Why are my requested custom ticket changes not showing on my tickets?
    • Best Practices
      • Security and Administration
      • Order Management
      • Product Pricing
      • Tax Code Defaults
      • Setting up a New Device
Powered by GitBook
LogoLogo
On this page
  • API Keys
  • Authentication
  • GraphQL
  • REST API
  • Useful Reference Links
Export as PDF
  1. References
  2. Web Portal
  3. Account and Administration

API Information

Last updated 1 year ago

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

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?

  1. 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.

  2. 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

https://server-name.fast-weigh.dev/v1/graphql
FWT API Rest Services
Welcome / Overview | Fast-Weigh Truck Scale Ticketing API
Overview
Authentication | Fast-Weigh Truck Scale Ticketing API
Authentication
Tooling | Fast-Weigh Truck Scale Ticketing API
Tooling
Overview | Fast-Weigh Truck Scale Ticketing API
Data Queries
Overview | Fast-Weigh Truck Scale Ticketing API
Custom Reporting
GraphQL Schema | Fast-Weigh Truck Scale Ticketing API
GraphQL
Crash Course | Fast-Weigh Truck Scale Ticketing API
REST API
Logo
Logo
Logo
Logo
Logo
Logo
Logo
Logo