API Calls
The platform offers numerous API calls to access different types of data.
The platform offers numerous API calls to access different types of data.
Implicit flow is used for authentication with AgSync using the server discovery page, client ID, and client secret. A client ID and secret may be obtained by contacting AgSync support.
This flow is used when the client does not want to create their own login page, but still wants refresh token ability.
Represents a batch group that is created, changed, or deleted.
Third-party integration partners will need to request developer accounts.
Swagger documentation for Dispatch Pro can be found by following the link below:
<BlockImageView
Below are commonly asked questions related to the Dispatch Pro API.
Represents equipment that is created, changed, or deleted.
The table below defines common error codes encountered in Dispatch Pro responses.
Represents a field operation that is created, changed, or deleted.
Additional documentation and resources pertaining to Dispatch Pro can be found below.
Documentation and references related to Dispatch Pro API.
Articles and guides to help users get started with Dispatch Pro.
The table below contains Dispatch Pro related terms. Their abbreviations and definitions are also listed.
The Dispatch Pro platform has specific Request and Response headers.
The Dispatch Pro platform has specific behaviour for the following HTTP methods:
This flow is a combination of the implicit flow and authorization code flow.
This flow can be used by both web-based and native applications.
For those users currently utilizing AgSync for retrieving or sending work to a display, upgrading to Dispatch Pro remains a worthwhile option. Dispatch Pro has numerous equivalent API calls that could allow a user to utilize a new API while keeping some functionality available through AgSync.
Pagination is supported on a handful of API endpoints. The intent is to continue to roll out paging for all API endpoints where paging makes sense. This section will explain how paging is implemented in Raven APIs. Pagination support detailed will eventually be implemented consistently across all endpoints that support pagination.
If one already has a refresh token and the access token has expired, one would need to get another access token using the refresh token. Submit a call to the token endpoint specified in the discovery document and pass the grant type with the token and a new access token will be received.
When specifying the response type, different data may be returned.
Dispatch Pro uses the same authentication process as AgSync.
Represents a shipment that is created, changed, or deleted.
A list of scopes is available at the discovery endpoints listed in Authentication. Further descriptions of AgSync specific supported scopes are listed below:
The Dispatch Pro platform utilizes documentation and endpoint testing via Swagger.
Third-party integration partners will need to request testing accounts.
Under construction.
Dispatch Pro has a web application accessible by AgSync users.
Webhooks allow one to build or set up integrations which subscribe to certain events at agsync.com. When one of those events is triggered, Dispatch Pro will send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external system, trigger custom notifications, or journal events with the order.