Setup

Platform API v2.0.0

Accessing the API

Access to the Platform API is granted as a costed add-on to your existing BOMcheck account. Costs are tiered based on number of API requests to ensure fair access to all account sizes.

Contact Sales

Environments

The following environment instance URLs will be provided for development, testing and final production integrations. Please note the current status of each environment instance.

• Demo Server: https://api.demo.bomcheck.com/v2 (ACTIVE)
• Production Server: https://api.bomcheck.com/v2 (ACTIVE)

Authorization

Authentication and authorization via Bearer API tokens issued per company account and delivered by your BOMcheck service account manager. The token must be present in the Authorization header when making requests to BOMcheck API v2 endpoints:

Authorization: Bearer <token>

For more information about the use of Bearer token authentication, please see:

• OpenAPI Bearer Authentication
• Mozilla HTTP authentication
• OAuth 2.0 Bearer Token Usage

Meta Endpoints

GET Ping API

/ping

Check the availability of the API.

Responses

200 OK

{
    "message": "OK",
    "documentation": "https://docs.bomcheck.com/en/api-docs/v2/",
    "status": "https://status.bomcheck.com/"
}

Please also see HTTP Responses.

GET Tier Quota

/quota

Check my organisations current API tier allowance and usage (see Tiered Usage).

Responses

200 OK

{
    "company": {
        "name": "ACME Electronics",
        "duns": "123456789"
    },
    "api:consume": {
        "authorized": true,
        "tier_limit": 1000,
        "tier_usage": 123
    },
    "api:request": {
        "authorized": true,
        "tier_limit": 1000,
        "tier_usage": 456
    },
    "api:declare": {
        "authorized": true,
        "tier_limit": 1000,
        "tier_usage": 789
    }
}

Please also see HTTP Responses.