## Overview

- Our API is accessible over HTTPS and is designed to be mostly **RESTful**.
- We use JSON format for both requests and responses. It is assumed that properly formatted JSON will be provided by the users.
- We recommend adding the **Content-Type: application/json** header to requests, although it is not strictly required.
- The base URLs for the API are **https://api.drayeasy.com/api/v2** for production environments and **https://apitest.drayeasy.com/api/v2** for testing purposes.


## Request Rate Limiting

For API requests, you are allowed up to 120 requests per minute.
The HTTP headers returned with any API request display your current rate limit status:


```
curl -i https://api.drayeasy.com/api/v2/users/profile
HTTP/1.1 200 OK
Date: Mon, 01 Jan 2023 17:27:06 GMT
Status: 200 OK
Content-Type: application/json
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 110
```

| Header | Description |
|  --- | --- |
| X-RateLimit-Limit | The maximum number of requests permitted per minute is 120. |
| X-RateLimit-Remaining | The number of remaining requests in the current rate limit window. |


## Authentication

We expect that you provide the API token as a Bearer token in the **Authorization** header of the request.
For example, `curl -X GET https://api.drayeasy.com/api/v2/users/profile -H 'Authorization: Bearer {your token}'`