Topics on this page

Developer docs > API docs >

How do I get started? (Classic BriteCore)

In this quick guide, we will cover the following steps:

  1. Contact the Support team to obtain your Classic BriteCore API key.
  2. Make a test request to BriteAPI.
  3. Evaluate the response.

We will also review status and error codes in BriteCore.

Step 1: Contact the Support team to obtain your Classic BriteCore API key

  1. Select Help at the top-right corner of the screen.
  2. Select the Submit a Support Ticket link.
  3. Complete the necessary fields in the Submit a Support Ticket dialog box, and then select Send Ticket.
Figure 1: How to access the Submit a Support Ticket dialog box.

If you do not have access to the link and are going through an active implementation, please contact your Consulting Project Manager. Otherwise, you can submit a Zendesk ticket to contact support.

Step 2: Make a request using your API key

To use your API key, pass it along to every call in the body of the request. For example:

View code
curl --location --request POST '/api/v2/utils/get_release_info' \

--header 'Content-Type: application/json' \

--header 'Cookie: webpy_session_id=f04842b8913042498902977fd69cef31961c7f56' \

--data-raw '{ "api_key": “" }'

Step 3: Evaluate the response

A successful JSON response from the above request: A successful request will return status code 200.

View code
{

"data": {

"timestamp": 1610496000,

"tag": "2021011300001"

},

"messages": [],

"success": true

}

Overview of status and error codes

BriteCore APIs uses standard HTTP response codes to indicate the success or failure of an API request and conforms to JSON:API standard error codes. The HTTPS status error codes include:

  • 200: The API request was successfully processed.
  • 300: The API request was successfully processed.
  • 400: Indicates a client-side error such as a bad request, unauthorized request, resource not found, etc.
  • 500: Internal server error.

In addition, as part of our error handling protocol, BriteCore APIs return a helpful error message if arguments aren’t provided, records aren’t found, processes don’t complete, etc.