Our JSON + RESTful API allows developers to build custom tools, services, and applications (for use on web, mobile, desktop, and POS) on top of our gateway, with most of the features available on the main Akatua website.
In order to start using our API, one needs application credentials, which can be obtained by following these steps:
If all goes well, an
Application ID and
Application Secret will be generated for your new application.
Our API requires authentication for every request made to it, making it necessary for every API call to send the authentication parameters along with it. Authentication is done by presenting the following HTTP headers in each of your requests.
|Content-Type||must always be "application/json"|
|Akatua-Application-ID||Application ID generated above, that uniquely identifies your application|
|Akatua-Signature||Unique hmac-sha256 hash generated for each request. This is generated by hashing (hmac-sha256) the entire JSON request object, using your |
All responses returned by the API are presented using the following parameters:
|success||true. This is only returned if the request was successful.|
|response||The actual response returned by the API. This is only available if success is true.|
|error||true. This is only returned if the request was unsuccessful.|
|errorText||description of the error (only available if error is true)|
|errorCode||Unique error code (only available if error is true)|