Getting Started
Last updated
Last updated
This guide will guide you through the basics of the usage of our API. By the end of reading through this guide you will be equipped by the knowledge of how to implement API requests to any of your endpoints.
For development purposes we recommend any tool that supports REST API exploration, here are a few of them:
Driffle API currently provides production
, sandbox
environment at the moment. Please use the following base URL while making HTTP requests:
We will discontinue sandbox support starting 1st June 2023. We will have a dummy product to test your integration. The dummy product will not be visible to the users & is private to you only.
Please Note that this API documentation is actively managed and supported indefinitely.
You need to generate an API Key to gain access. Driffle APIs uses authorization mechanism with Bearer
tokens.
Once you have generated an API Key, you need to get an access_token
. To get it, you will have to use the API Key
you got in the "Generating an API Key" step above.
The following describes how you can get an access token for production
environment:
Creates a token from an API Key. This token is then used to authorize further API calls.
Headers
Content-Type
application/json
Body
apiKey
string
The API key provided for authentication.
Yes
Response
Take a look at the following sample request on how you might call this method using curl
, NodeJS
and PHP
:
The above request responded with following response:
All requests to our REST API must contain a Bearer
access token in the Authorization
HTTP header. Use the access_token
you acquired in #2.-authorization as follows:
The acquired access_token
is temporary and will expire after 30 minutes. You will need to regenerate the access_token as mentioned in #2.-authorization to keep the API implementation secure.
To protect internal systems, Driffle API implements rate-limiting. There are two types of rate-limiting strategies - global
and action
.
Your IP address is limited to 4000 requests per 10 min
.
Some actions are protected by specific limits:
Update offer price
/offer/update-price
1 request per 3 seconds
Toggle Offer i.e. enable/disable
/offer/toggle
1 request per 3 seconds
Access Token generation
/token
2 requests per 1 minute
Update Offer
/offer/update
1 request per 3 seconds
Bulk Update Offers
/offer/bulk-update
1 request per 5 seconds
Rate Limiting Headers In Response -
RateLimit-Remaining RateLimit-Limit
You can get your credentials from the . You will need to go to the seller dashboard and click on the API settings
page. On this page, you will be able to create a new API key.
POST