GET
, POST
, PUT
, DELETE
, etc. methods with the URL of the API
service, the URI of the resource you want to access, and any parameters or data you want to send to the API along with
one or more HTTP request headers.
The URL to the server is either one of the following:
https://dev.superpool.unyte.com
https://superpool.unyte.com
https://dev.superpool.unyte.com/v1
. and include
![query parameters] on GET
calls to manage (limit, filter or sort the size of) the data in the responses. Please, note
that most write-through APIs (POST
, PATCH
, PUT
) would require (mostly) a JSON request body.
An example of a sample request that list all products avaiable on the platform is:
offset
: The number of items to skip before starting to collect the result set. This is useful for pagination.limit
: The maximum number of items to return. This is useful for limiting the size of the response.Accept
: The type of data that the client is willing to accept in the response. For example, application/json
forContent-Type
: The type of data being sent in the request body. For example, application/json
for JSON data.X-API-Key
: The API key used to authenticate the request. This is required for all requests to the API. JSON data.U-Request-Id
: A unique key used to identify the request. This is useful for ensuring that the same request is not
processed multiple times. Although, Optional. We advise you to please provide for all POST
requests to the API.