For a smooth integration process we provide an Integration Guide with information for the different use cases. Before you start the development we like to have a call with you to discuss the integration process. Please contact us to schedule a call: [email protected]
The e-guma API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors.
As we only support JSON data, the API expects the Content-Type header to be set to application/json.
JSON will be returned in all responses from the API.
You authenticate to the e-guma API by providing an API key in the request. The API keys are assigned to e-guma users. You can manage the API keys from the e-guma account. There can be multiple API keys active at one time. Authentication to the API occurs via query string in the request URL. You must set the API key for all requests.
Errors are returned using standard HTTP error code syntax. An additional message is included in the body of the return call as plain text.
Bad Request - Often missing a required parameter.
Unauthorized - No valid API key provided.
Server errors - something went wrong on e-guma's end.
For questions, please write to [email protected].
Updated 12 months ago