Convelio Public API (2.0)
This document describes the current version (2.0) of the Shipping API.
The Convelio API is organized around REST. Our API has predictable resource-oriented urls, accept and return json-encoded requests and responses. It also use standard HTTP response codes, authentication, and verbs.
You can use the Convelio API in sandbox mode, which does not affect your live data or interact with the live api. The API key you use to authenticate the request determine whether the request is live mode or sandbox mode.
Convelio authenticates your API requests using your account’s API key. If you do not include your key when making an API request, or use one that is incorrect, Convelio returns an error.
Your API key has a Secret type, prefixed by sk, and should be kept confidential and only stored on your own servers. Your account’s secret API key can perform any API request to Convelio without restriction.
There are also two modes for your API key: live and test.
- live key can only be used on our production server.
- test key can only be used on our sandbox server.
Example of key by modes
| Type \ Mode | Test | Live |
|---|---|---|
| Secret | sk_test_0000000000000000000000000 | sk_live_0000000000000000000000000 |
Obtaining your API key
To get your API key, please send your request at api@convelio.com.