The main purpose of this API is to explain how you can operate with Deliveries in our system.
Remember that before you start implementing any API request you need to have a valid API Key. Additionally, once you have the API Key please read the section about Authentication.
How to start
As first step to start, we recommend you to prepare your test environment.
Once you have your local test environment ready and you acquired the API Key.
How to get an API Key
The process to issue an API Key is the following:
- Ensure that your agreement has been signed with SendIt.green.
- Send an email to firstname.lastname@example.org including the retail you represent for further validation.
- Within 72hrs you will receive the API Key that will be valid for test and production environment.
- After this you can already start to implement our services.
How to be Authorized
Our API works with simple API Key validation. You can pass in the API Key to our API either by using the HTTP header or by sending it via the query string.
Our recommended authentication process is via the HTTP Header, illustrated with a curl command as follows, but easily replicable with any programming language you are using.
-X POST 'https://api.sender.production.sendit.green/standard/delivery?id=DEYDRHWNZGT97KF8' \
-H 'Authorization: Bearer <API Key>'
Alternatively you can use the token in the Query String, although we don't recommend this method.
-X GET 'https://api.sender.production.sendit.green/standard/delivery?id=DEYDRHWNZGT97KF8?access_token=<API Key>'