Get requests rate limits

API Documentation: Rate Limit Status Retrieval

This API allows external systems to check the rate limit status for API requests to the 4ws.trade suite. It provides real-time details about the number of requests made, remaining requests, and reset timing.

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

Preconditions

The external system must have the necessary permissions and access to the document creation service, please refer to Authentication.

Ensure the token is valid and included in the Authorization header if required.

Main Success Scenario

API Client sends a GET request to retrieve rate limit status.

4ws.suite Platform processes the request and returns the current rate limit details:

Number of requests made (requestsMade).

Remaining requests before hitting the limit (requestsBeforeLimit).

Whether additional requests are allowed (canMakeRequests).

Time when the limits will reset (resetTime).

Remaining time until reset in seconds (resetsIn).

{
  "requestsMade": 0,
  "requestsBeforeLimit": 0,
  "canMakeRequests": true,
  "resetTime": "2024-11-15T16:19:17.620Z",
  "resetsIn": 0
}

Alternate Flows

Unauthorized Access: If the client lacks the necessary permissions or the token is missing/invalid, an error response is returned with a relevant message.

{
  "message": "Unauthorized",
  "errors": [
    {
      "msg": "Token is missing or invalid",
      "param": "Authorization",
      "location": "header"
    }
  ]
}

Sequence Diagram

Best Practices

Please refer to Best Practices for Error Handling in External System for best practices on implementation.

Code Examples in Node.js

Retrieve Rate Limit Status:

application/json

Body

Example

{
    "requestsMade": 0,
    "requestsBeforeLimit": 10,
    "canMakeRequests": true,
    "resetTime": "2024-09-02T14:45:45.861Z",
    "resetsIn": 15000
}

Get requests rate limits

API Documentation: Rate Limit Status Retrieval

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js

Request

Request Code Samples

Responses

Get requests rate limits

API Documentation: Rate Limit Status Retrieval#

Actors#

Preconditions#

Main Success Scenario#

Alternate Flows#

Sequence Diagram#

Code Examples in Node.js#

Request

Request Code Samples

Responses

API Documentation: Rate Limit Status Retrieval

Actors

Preconditions

Main Success Scenario

Alternate Flows

Sequence Diagram

Code Examples in Node.js