All functions can be found in the API documentation: API Documentation
plenigo API uses the following authentication:
Security Scheme Type: API Key
Header Parameter Name: X-plenigo-token
For using the corresponding endpoints, access rights are required which have to be defined in the Merchant Backend when creating API access tokens. You will find the information on which access rights are required for each endpoint at the top of each tab in the API documentation.
The required API token can be created, managed and copied in the Merchant Backend in the corresponding client.
Requests
The HTTP methods (e. g. GET and POST) determine the type of operation at the ressource. Additional options for GET requests can be provided by using request parameters. POST parameters deliver data for writing operations, such as creating and changing ressources.
Status Codes
The following status codes are used in the plenigo API:
Code 2xx - indicate a successful request.
Codes 4xx - indicate a client-side issue with this request.
Codes 5xx - indicate a server-side issue with this request.
Response
The API response comes in JSON format. At the moment, the plenigo API does not support any other format.