Skip to content
English
  • There are no suggestions because the search field is empty.

API Management

Application Programming Interface (API) keys are unique identifiers used to identify and authorize access.


Last Updated: May 14, 2025

Applies to:

Shippers, Brokers, Carriers, and Partners

Common Scenario(s)/Challenge (s):

API management within G2Mint allows the ability to limit (or revoke) access, enforce security policies, and track frequency of access by a defined User. More specifically, G2Mint API Management allows the licensed User to limit access of a Guest Use by Account (for example, a Carrier account may only access Shipments Tendered to them, or a Shipper account may have Read Only access to their account) or by Role (for example, a Broker’s Procurement Role may be able to create Carrier accounts, Contacts and Agreements but is restricted from creating Shipments).  To go a step further, G2Mint can scope each issued API Key to a specific function, such as Rating (request and response), Edit/ Upload (Agreement and/or Rate Plan), Create (Order, Shipment, Load) and Tracking.  

Create an API Key

  1. Select My Account dropdown
  2. Select API Management

      3. Select + Create New
      4. Enter General Information (API Name, Account Associated to API, Expiration Date and               Select desired Roles associated with this Key)

       5. Select Create
       6. API Key will be stored within the API Key Library

Note: If no Roles were available, refer to User Management, or follow these steps:

  1. Select My Accounts dropdown
  2. Select User Management
  3. Select Roles

     4. Select + Create New

     5. Ensure Type selection is API

     6. Select Save
     7. Add Role accessibility, determining if Read, Edit or Delete access is given to All, or Those They Own

This Role will now be available to be used in an API Key creation