Overview
<h2>Overview</h2>
<ul>
<li>Our API is accessible over HTTPS and is designed to be mostly <strong>RESTful</strong>.</li>
<li>We use JSON format for both requests and responses. It is assumed that properly formatted JSON will be provided by the users.</li>
<li>We recommend adding the <strong>Content-Type: application/json</strong> header to requests, although it is not strictly required.</li>
<li>The base URLs for the API are <strong><a href="https://api.drayeasy.com/api/v2">https://api.drayeasy.com/api/v2</a></strong> for production environments and <strong><a href="https://apitest.drayeasy.com/api/v2">https://apitest.drayeasy.com/api/v2</a></strong> for testing purposes.</li>
</ul>
<h2>Request Rate Limiting</h2>
<p>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:</p>
<pre><code>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</code></pre>
<table>
<thead>
<tr>
<th>Header</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>X-RateLimit-Limit</td>
<td>The maximum number of requests permitted per minute is 120.</td>
</tr>
<tr>
<td>X-RateLimit-Remaining</td>
<td>The number of remaining requests in the current rate limit window.</td>
</tr>
</tbody>
</table>
<h2>Authentication</h2>
<p>We expect that you provide the API token as a Bearer token in the <strong>Authorization</strong> header of the request.
For example, <code>curl -X GET https://api.drayeasy.com/api/v2/users/profile -H 'Authorization: Bearer {your token}'</code></p>