{"id":6870,"date":"2023-03-14T08:55:39","date_gmt":"2023-03-14T07:55:39","guid":{"rendered":"https:\/\/helpdesk.kontainer.com\/article\/kontainer-api-integration\/"},"modified":"2026-03-12T15:16:14","modified_gmt":"2026-03-12T14:16:14","slug":"kontainer-api-integration","status":"publish","type":"article","link":"https:\/\/helpdesk.kontainer.com\/de\/article\/kontainer-api-integration\/","title":{"rendered":"Kontainer API Integration"},"content":{"rendered":"

\"API<\/p>\n

The Kontainer API provides an easy integration of your existing software into the Kontainer platform. This software-to-software interface allows your applications to exchange data with Kontainer and can be used to automate many different processes.<\/p>\n

In the following, we will go through the basics of the API setup.<\/p>\n

The information in this article is technical and targeted at developers in charge of API setup. If you have any questions, feel free to let us know.<\/p>\n

\n

API Code<\/h2>\n

Get straight to the code for API integration HERE<\/strong><\/a>.<\/span> <\/span><\/p>\n

NOTE<\/strong> that you need to use your unique Kontainer URL instead of the one in the example in the above-listed links („api.kontainer.com“).<\/em><\/p><\/blockquote>\n

 <\/p>\n

\n

Getting Started<\/h2>\n

In order to use Kontainer API, you\u2019ll need an account with Kontainer, as well as an API access token.<\/p>\n

Please contact your local administrator or\u00a0Kontainer Support<\/a> for additional information on how to get access to the Kontainer API.<\/p>\n

Authentication<\/h3>\n

The Kontainer API utilizes OAuth<\/em> for authentication. Once you’ve been given an API access token, you must provide this token in each request via the Authorization header as a „Bearer“ value.<\/p>\n

All requests must include your provided API access token in the Authorization header: Authorization: Bearer {{access-token}}<\/code><\/mark><\/p>\n

Content Negotiation<\/h3>\n

All requests\u00a0must<\/strong>\u00a0include the header:\u00a0 Accept: application\/vnd.api+json <\/code><\/mark>.
\nRequests sending JSON data\u00a0must<\/strong>\u00a0include the header:\u00a0 Content-Type: application\/vnd.api+json <\/code><\/mark><\/p>\n

JSON:API Standard<\/h3>\n

The Kontainer API is RESTful<\/em> API following the\u00a0JSON API<\/a> standard. You can refer to this standard for more information on how the request and response documents are structured.<\/p>\n

Rate Limits<\/h3>\n

The standard API rate limits apply to all endpoints we provide, and the limit is 500<\/code><\/mark> requests per minute. Exceeding the defined rate limit will result in API responding with the response message: 429: Too Many Attempts<\/code><\/mark>.<\/p>\n

Response Codes<\/h3>\n

The Kontainer API responds with HTTP status codes and JSON-based error codes and messages.<\/p>\n

HTTP Status Codes<\/h3>\n

The following table gives an overview of HTTP status codes that are returned.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Status Code<\/strong><\/th>\nText<\/strong><\/th>\nDescription<\/strong><\/th>\n<\/tr>\n<\/thead>\n
200<\/td>\nOK<\/td>\nSuccess.<\/td>\n<\/tr>\n
201<\/td>\nCreated<\/td>\nObject created.<\/td>\n<\/tr>\n
204<\/td>\nNo Content<\/td>\nNo content returned.<\/td>\n<\/tr>\n
401<\/td>\nUnauthorized<\/td>\nToken is missing or invalid.<\/td>\n<\/tr>\n
403<\/td>\nForbidden<\/td>\nResource or Request not supported<\/td>\n<\/tr>\n
404<\/td>\nNot Found<\/td>\nObject not found.<\/td>\n<\/tr>\n
406<\/td>\nNot Acceptable<\/td>\nRequest not acceptable<\/td>\n<\/tr>\n
409<\/td>\nConflict<\/td>\nApplication or resource state conflict.<\/td>\n<\/tr>\n
422<\/td>\nValidation Error<\/td>\nValidation error occurred.<\/td>\n<\/tr>\n
429<\/td>\nToo Many Requests<\/td>\nRate limit exceeded.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Error Messages<\/h3>\n

The following example illustrates how an error messages will looks like for HTTP status code\u00a0401 - Unauthorized<\/code><\/mark>.<\/p>\n

<\/p>\n

Filters<\/h2>\n

Filters can be applied to supported endpoints to limit the results that are returned. Filters are applied by using the filter<\/code><\/mark> query parameter. You can find the filter fields that are supported in the\u00a0Filter Attributes<\/strong>\u00a0section of each endpoint.<\/p>\n

Examples:<\/strong><\/p>\n

Get a list of Category Items\/Products:<\/p>\n

filter[description][like]<\/code><\/mark>\u00a0:\u00a0Shoes<\/code><\/mark><\/p>\n

Find items by exact EAN:<\/p>\n

filter[ean][eq]<\/code><\/mark>\u00a0:\u00a04194382028137<\/code><\/mark><\/p>\n

Find items after a certain date:<\/p>\n

filter[released_on][gt]<\/code><\/mark>\u00a0:\u00a02020-01-01<\/code><\/mark><\/p>\n

Find items with unit cost greater or equal to 22.50, and less than 50.00:<\/p>\n

filter[unit_cost][gte]<\/code><\/mark>\u00a0:\u00a022.50<\/code><\/mark><\/p>\n

filter[unit_cost][lt]<\/code><\/mark>\u00a0:\u00a050.00<\/code><\/mark><\/p>\n

Filter Qualifiers<\/strong><\/p>\n