Skip to main content

Common

The "Common" section of the API documentation provides a set of endpoints that are frequently used across different operations. These endpoints handle fundamental tasks, such as authentication and service status checks, which are essential for ensuring smooth communication between your application and the API. Understanding these endpoints is crucial for maintaining an efficient integration process.

One of the key endpoints in this section is POST /token. This operation is responsible for generating an authentication token. To access this endpoint, you must provide valid credentials, including a username and password specific to each shop. The returned token is essential for authenticating further requests. It's important to store the token securely and be prepared to request a new one if it becomes invalid, as unauthorized errors can occur.

Another important endpoint is GET status/get, which serves as a quick way to check the status of the ShopAPI. It requires no authentication and provides a simple confirmation that the API is functioning properly. When the service is available, the response includes a message confirming that the status is OK.

Finally, GET settings/get returns the ids of your configuration, such as orderTypes. You need these ids in other requests, so look them up once and keep them at hand.