Reference

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.

• Environments
• Authorization
• Submit
  • POST XML Upload
  • GET Submission Status
• Consume
  • GET XML Download
• Integrate
  • GET Substance Lists
  • GET Exemption Lists
  • GET Supplier DUNS
• Meta
  • GET Ping API
  • GET Tier Quota

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 (INACTIVE)
• Production Server: https://api.bomcheck.com/v2 (INACTIVE)

Authorization

Authentication and authorization is controlled by Bearer API tokens issued per company account and delivered by your BOMcheck service account manager or support team. 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

Submit

Tiered Usage

Request calls made to all Submit endpoints will count towards your API tiered usage allowance. For more info please see Usage Allowance.

POST XML Upload

/submissions/xml

Launch and interact with BOMcheck functionality by uploading relevant IPC 1752 XMLs in the available formats (more info in the XML Files section). Functional availability (as per the Scope Roadmap):

• Create an RCD: Upload a 1752A/B Class C file in Distribute mode.
• Create an FMD: Upload a 1752A/B Class D file in Distribute mode.
• Request Supplier Declarations: Upload a 1752A/B Class C or D file in Request/Reply mode.

Returns a SubmissionStatusDto containing a unique submission number which can be used to poll the GET Submission Status endpoint.

Parameters

No parameters

Request Body

The POST request body should be IPC 1752 XML raw content information in line with the IPC Material Declaration Standard and conform to Content-Type: application/xml.

If the uploaded XML file passes initial HTTP checks the contents will be validated with any validations being available as part of the SubmissionStatusReport object.

Request Process Flow

Responses

202 Accepted

// Response Code: 202
// SubmissionStatusDto Response Object
{
  "submissionNumber": "c039b3142422",
  "statusUrl": "https://api.bomcheck.com/v2/submissions/c039b3142422",
  "reportUrl": "https://app.bomcheck.com/apiv2/submissions/c039b3142422"
}

Please also see HTTP Responses.

GET Submission Status

/submissions/{submissionNumber}

Returns a SubmissionStatusReport containing information on the current processing status of a previous submission to the POST XML Upload endpoint.

Parameters

submissionNumber

• String
• Required

The identifier used to retrieve the relevant submission report. Returned as an attribute of the SubmissionStatusDto object or obtained from the BOMcheck API dashboard user interface. Should be provided as a path parameter in the request URL.

Request Process Flow

Responses

200 OK

// Response Code: 200
// SubmissionStatusReport Response Object
{
  "status": "PENDING",
  "filename": "Partnumber12345.xml",
  "submissionNumber": "c039b3142422",
  "reportUrl": "https://app.bomcheck.com/apiv2/submissions/c039b3142422",
  "refValue": "005056b7-b57b-4ed9-b1ae-c99fb9dec1e7",
  "validations": [
    {
      "context": "175x:ZZZZZZZZZZZZZZZZ-AAAAAAAAAAA",
      "level": "FAIL",
      "code": "BR068"
    }
  ],
  "refType": "Part itemNumber",
  "submissionDate": "2019-10-11T10:58:00.726928+03:00",
  "dataUuid": "anyname.xml"
}

Please also see HTTP Responses.

Consume

Tiered Usage

Request calls made to all Consume endpoints will count towards your API tiered usage allowance. For more info please see Usage Allowance.

GET XML Download

/consume/xml

More info will be released following the Scope Roadmap.

Integrate

GET Substance Lists

/integration/substances

More info will be released following the Scope Roadmap.

GET Exemption Lists

/integration/exemptions

More info will be released following the Scope Roadmap.

GET Supplier DUNS

/integration/suppliers

More info will be released following the Scope Roadmap.

Meta

GET Ping API

/ping

Check the availability of the API.

Responses

200 OK

// Response Code: 200
{
    "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 allowances and usage. See Tiered Usage for more info.

Responses

200 OK

// Response Code: 200
{
    "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.