Overview

Integration in your system

For a smooth integration process we provide an Integration Guide with information for the different use cases. To get a Demo API key or if you have any questions, please do not hesitate to contact us ([email protected]).

REST

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.

Always set the required headers

As we only support JSON data, the API expects the Content-Type header to be set to application/json.

Response format

JSON will be returned in all responses from the API.

Authentication

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.

Error handling

Errors are returned using standard HTTP error code syntax. An additional message is included in the body of the return call as plain text.

Questions

For questions, please write to [email protected] (in german or english).