Developers - REST API v1

Overview

Integration in your system

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: developers@e-guma.ch

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.
400 Bad Request - Often missing a required parameter.
401 Unauthorized - No valid API key provided.
500 Server errors - something went wrong on E-GUMA's end.

Questions

For questions, please write to developers@e-guma.ch.

Kontakt

Idea Creation GmbH
Walchestrasse 15
8006 Zürich
Tel. +41 44 500 54 00
info@e-guma.ch

Support
support@e-guma.ch
TeamViewer herunterladen

Social Media