Connecting with the API
Authentication to the CrescoData API is done using a client id / secret as well as a username and password. These credentials will be issued by CrescoData and provided during the on-boarding process.
The CrescoData API gives access to all of CrescoData’s services such as:
- Account setup and maintenance
- User setup and maintenance
- Status monitoring and alerts
- Reporting data
All communication uses the CrescoData format which is outlined in the CrescoData API Documentation. This means, orders, products and all other data sent to or provided by the system, will be in the CrescoData format unlike the formats used in the Streams and Webhooks APIs.
APIs - Streams API
The Streams API is a set of API endpoints that supports sending data in a pre-defined custom format to the CrescoData system which will automatically map it into the CrescoData format thereby removing one step that would have to be taken by any integration - mapping data to the CrescoData format.
The Streams API uses the same authentication as the standard CrescoData API unlike the Webhooks API which is a simpler signature based authorisation.
The workflow of the Streams and Webhooks APIs are identical. The Streams API is available to offer a single authentication method for integrations that also use the CrescoData API for account setup.
APIs - Webhooks API
The Webhooks API is a set of APIs that allows sending data to CrescoData in a custom predefined format.
The authentication for the Webhooks API depends on the integrations but is usually signature based. The workflow of the Streams and Webhooks APIs are identical. The Streams API is available to offer a single authentication method for integrations that also use the CrescoData API for account setup.