Getting Started
The following section describes general information about the API and helps you to get started with working with our API.
API Base URL
To communicate with the API you need to know the base URL. The base URL for the echonovum API is a follows:
Sandbox environment
We can provide you with a so-called "sandbox organization" for you to test your integrations. Note that the sandbox organization is isolated from your productive organization.
To get a sandbox environment get in contact with Customer Success.
Authentication
To interact with our API you need to authenticate with an API key. The API key needs to be provided in every request as part of the HTTP-headers as follows:
API keys can be created in the echonovum Hub. Refer to an owner of your organization to obtain one. The API key should be kept secret and should not be shared with anyone. Furthermore, API-Keys are bound to organizations and can not be used across organizations. Thus, and API key is organization specific and will authenticate you to only create, read, update and delete resources within your organization. So to play with your Sandbox organization you need to use the API key of your sandbox organization and vice versa.
JSON:API Standard
Our API currently follows a well-defined JSON standard called JSON:API standard. This is not to be mistaken with regular JSON based API. The JSON:API standard follows a distinct set of rules that you need to follow to interact with our API.
To ready further look at the section JSON:API-Standard in this documentation.
Supported Content Types
One of the rules is to specify the Content-Type in your requests as application/vnd.api+json:
The API will respond with the same content type.
Pagination
Collection resources are paginated. The pagination follows the JSON API standard. Specify the page query parameter to loop through the pages.
Example: /en/v1/profiles?page=5