Greenstone Data Hub - API Partner Connection requirements, partner onboarding steps and usage limits.

If you are a Greenstone partner who has completed the process of becoming an authorized integrator for CINCH, please follow the instructions below.

Note: If you are a vendor or a CINCH customer and have not completed this process, please contact your account manager before continuing.

Instructions

API documentation

Greenstone provides sample documentation for supported API’s. Customers and business partners can use the documentation to see how our existing API’s produce transactions within CINCH.

View Sample API’s →

API’s include:

/api/cinch/item/createItem
/api/cinch/item/updateItem {includes cost and price}
/api/cinch/item/deleteItem {will be marked as discontinued if unable to be deleted}
/api/cinch/purchaseReceipt/createPurchaseReceipt
/api/cinch/shipment/createShipment

Our API’s are built on the REST (REpresentational State Transfer) architecture and require a specific authentication token that is unique for each provider and customer using our API’s.

Greenstone requires a User ID to be present when integrating with our API’s. This information will be used to identify the users who are creating change/integration requests within the Greenstone Data Hub. The User ID is only used for informational purposes and will not be validated.

Authentication Token

Our authentication token expires after 24 hours, instructions below indicate how to refresh a token and best practices on how to store/utilize our tokens.

(sample call )

by sending your call to:

https://gdhapps.auth0.com/oauth/token

{
"client_id":"PROVIDED BY GREENSTONE",
"client_secret":"PROVIDED BY GREENSTONE",
"grant_type":"client_credentials",
"audience":"http://localhost/GDH/",
"authority":"https://gdhapps.auth0.com/"
}

The above POST request returns a JWT token which should be kept in Application cache and sent in the Authorization header of each API requests. (See below snap for information)

Our authentication token expires after 24 hours. Refresh the token by reauthenticating it using the payload provided for authenticating.

USAGE LIMIT:
You should typically not use more than 1 token per day. This requires that you cache the token for reuse. We suggest implementing logic to cache the generated token for the day and use that token in subsequent calls until you receive an unauthenticated response from the Greenstone Data Hub. At that point you should generate a new token.

To ensure your integration continues to operate please ensure you are not exceeding usage limits, Greenstone reserves the right to deny service from any partner who is not managing token refreshing.

Example using postman.

Get postman here!

Using the Greenstone Data Hub API’s

If you receive an error when calling our API, the message was not received and will be required to be resent. Common failures will be that the message/parameters are not formatted correctly and did not pass our cursory validation. Any errors that fail processing into our backend system (CINCH), an example might be where a vendor doesn’t exist on receiving the transaction, an alert will be generated to the customer’s admin and the ability to reprocess, edit, and delete the message.

You should expect that messages will be processed in the order they are received.

CINCH Customer Documentation