BRIX API Access Token Guide

This document outlines the steps to obtain an access token for authenticating and authorizing API calls to the BRIX API. The token must be included in the Authorization header of HTTP requests.

Overview

To access the BRIX API, you will need an OAuth 2.0 access token using the Client Credentials Flow. This requires a client_id and a client_secret, which are provided by Hyphen Solutions.

Authorization Credentials

• Client ID: < client_id >
• Client Secret: < client_secret >

Token Endpoint

Use the following endpoint to obtain a JWT (JSON Web Token):

https://auth-brix-api-uat.hyphensolutions.com/oauth2/token 

Request Details

Headers

• Content-Type: application/x-www-form-urlencoded

Body Parameters

• grant_type: client_credentials
• scope: A space-delimited list of required scopes:

• brix-api-uat/post
  brix-api-uat/get
  brix-api-uat/patch
  brix-api-uat/put
  brix-api-uat/delete 

Example Request

POST /oauth2/token HTTP/1.1
Host: auth-brix-api-uat.hyphensolutions.com
Authorization: Basic Base64(client_id:client_secret)
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
scope=brix-api-uat/post brix-api-uat/get brix-api-uat/patch brix-api-uat/put brix-api-uat/delete

Basic Authentication

The Authorization header uses Basic Auth, which is a base64-encoded string in the format:
Base64(client_id:client_secret)

BRIX APIs

API Directory:

• Customer API
• Scheduled Date API
• Transactions API