How it works 👷

API description

Our SaaS solution consists of a RESTfull API exposed to clients under the following connection requirements:

• Access to resources is done through the HTTPS protocol.
• Bearer Auth credentials are required, check authentication guide.
• JSON formatted requests and responses.
• The request method (verb) determines the nature of the action to perform. A request using the GET method means your are getting something back from Deliverea, while a POST would save something new into Deliverea.
• The API call will respond with appropriate HTTP status codes for all requests. When a response is received, the status code is highlighted and provided along with a help message showing the possible meaning of the response code.
  • 2XX OK codes mean a successful response.
  • 4XX codes relate to client errors. For instance a 404 entails that the resource was not found.
  • 5XX response codes indicate server errors in case our API is facing an internal issue.