REST API

Documentation

Integrate marketplace data into your applications with the SETALABS REST API. Explore endpoints, authentication, request signing, response formats, and everything you need to start building reliable integrations.

Overview

Our service implements a REST API. All responses are returned in JSON format.

JSON

Base URL

Use the following base URL for all API requests:

https://gw.setalabs.com

Health Check

A basic request to verify that the API is up and running:

GET /health
https://gw.setalabs.com/health

API Endpoints

Requests to the API are made according to the method descriptions for each API. The request path starts with:

/v1/api/{uuid}/…

where :uuid is the unique identifier of the API.

Authentication

To authenticate, pass your API key in the request header:

Header Required Description
X-Api-Key Always Your API key.

If a secret is configured for your API key, you must also pass a signature and a timestamp:

Header Description
X-Api-Sign Request signature (see below).
X-Api-Timestamp Unix timestamp of the request.

Request Signature

When a key secret is enabled, compute the signature as follows:

  1. Concatenate in order: X-Api-Key, key secret, X-Api-Timestamp, and request path.
  2. Compute the HMAC-SHA256 hash of the resulting string.
  3. Pass the result in the X-Api-Sign header.
payload = X-Api-Key + key_secret + X-Api-Timestamp + request_path

Example for GET /v1/api/{uuid}/items: 

X-Api-Sign = HMAC-SHA256(
  X-Api-Key + key_secret + X-Api-Timestamp + "/v1/api/{uuid}/items"
)