MercuryGate APIs: API Documentation (beta)
Starting with our Digital Freight initiative, new APIs to interoperate with MercuryGate will be implemented as REST-ful endpoints secured using OAuth2 access and refresh tokens which are generated per-tenant via authorization code flow. The expectation is that partners will make calls to MercuryGate endpoints using the MercuryGate API, and implement endpoints on the partner side for MercuryGate to call using the MercuryGate API. If you do not have the resources to connect using our defined APIs, MercuryGate has partners that can help you write services or can write transformations between our API and yours.
One of the goals of this integrations initiative is to allow customers to authorize an existing partner integration with no or minimal interaction with staff. To this end, there are systems in development to allow both customer and partner self-service, using primarily systemic means such as OAuth's authorization code flow.
Below you can find additional information about the various API integrations:
Load information is entered into the MercuryGate TMS though an import or manual entry. A user will then request rates, which includes a call to Digital Freight partners. Rates can be contracted rates or quotes; the difference being that quotes typically have a human-readable quote number for reference as well as an expiration date and time. Because the MercuryGate TMS is omni-modal, digital freight partners may receive requests for
Description: Implement an endpoint that accepts a Rate Request and returns a list of Rates. See documentation for more implementation details.
Documentation: Rating API developer Swagger documentation
Configuration: Provide MercuryGate with your endpoint url (e.g. {yourhost}/svc/rates/v1/rate-request) and we will call your URL once a rate request is initialized from MercuryGate TMS.
Description: Implement an endpoint that accepts a Booking Request and returns a Booking Response. See documentation for more implementation details.
Documentation: Booking API developer Swagger documentation
Configuration: Provide MercuryGate with your endpoint url (e.g. {yourhost}/svc/booking/v1/booking-request) and we will call your URL once a booking request is initialized from MercuryGate TMS.
Description: Call this api to create a new status update intended for a recipient inside the MercuryGate TMS
Documentation: Status Update API developer Swagger documentation