Usage Allowance

v2.0.0

Draft Specification

The BOMcheck Platform API (v2) is currently in active development and as is subject to change. Please see the Scope Roadmap for delivery timeline.

Requests to the BOMcheck API v2.0 are authorized and throttled based on your account settings and two time period specific request counters.

Tiered Usage

There are three aspects to the BOMcheck API v2.0 which allow users to integrate with different functionality within the BOMcheck system via tiered usage:

1. Submit/Declare (make RCD and FMD declarations)
2. Submit/Request (launch supplier declaration requests)
3. Consume (download RCD and FMD declarations)

For each of these three options a user may make a certain amount of HTTP requests per annum based on their usage tier (see the table below). Requests to all other endpoint categories (Integration, Meta etc.) will not count toward tiered usage allowances.

Tiered HTTP Requests Per Annum

Tier	Submit/Declare	Submit/Request	Consume
Small	≤1,000 pa	≤1,000 pa	≤1,000 pa
Medium	≤10,000 pa	≤10,000 pa	≤10,000 pa
Enterprise	Contact	Contact	Contact

Any requests which exceed your annual tiered usage quota will receive 429 Too Many Requests responses. You may check your current tier authorization and usage quota from the BOMcheck dashboard and via the GET Quota endpoint.

Request Rate Limit

In addition to tiered usage authorization and request limits, the BOMcheck API v2.0 implements standard request rate limits for all users whereby no user may make more than 10 API requests per minute. This limitation ensures availability and up-time can be maintained for all users whilst process heavy requests are made to the BOMcheck infrastructure.

Rate limit counts (limit, remaining, reset) can be found in standardised X-RateLimit-{Count} headers on every API request response as shown below.

// Rate Limit Headers
// X-RateLimit-Limit: <integer>
// X-RateLimit-Remaining: <integer>
// X-RateLimit-Reset: <dateTime>
{
    "message": "{FooBar}"
}