Authenticating to use beqom APIs

This article details the steps and operations to be performed in order to authenticate to use beqom APIs.

Configuring the third-party account

In order to start consuming beqom APIs, a third-party service account needs to be generated for the target tenant. The following information need to be provided to the Ops Team in a Zendesk ticket.

Information for requesting a third-party service account

Information	Description
Passport user (must be linked with a user account in the related tenant)	Passport user who is going to be authenticated
Tenant ID	Tenant that is going to be used
Application Version	Application version that is going to be used

Once the Ops Team receives the information, they will provide the following parameters:

• Client ID

• Client secret pair

• Target URLs

Client ID and secret pair parameters

Parameter	Description
client_id	API Key
client_secret	Symmetric Signing Key

Target URLs

URL	List of Available Methods
Gateway Service API URL	URL/Swagger
CompPlanner Service API URL	URL/Swagger

Authentication

beqom owns an identity provider called Passport to acquire a JSON Web Token (JWT) that is then used to access all the connected systems or tenants.

Copy

Endpointhttps://passport.beqom.com/api/auth
 
Action
POST
 
Header
Content-Type: application/json
 
Body
{
"client_id":"",
"client_secret":""
}
 
Parameters
-
 
Output sample
{
"access_token": "eyJ0eXAx4x4jnuFwdY3rfqBJuN0mXYCiPm-qqvwrAgxSs",
"token_type": "urn:ietf:params:oauth:token-type:jwt",
"expires_in": 3599,
"refresh_token": null
}

Use the access token and pass it to all APIs through the header.

The standard authorization header is the following: Authorize bearer {Access Token}

Copy

Endpoint{REST API URL}/api/classic-datasource/{id}/data-search
 
Action
POST
 
Header
Authorize bearer {Access Token}
 
Body
{
"pageSize": 25,
"page": 1,
"filter": {
"fields": [
{
"type": 1,
"name": "string",
"values": [
{}
]
}
]
}
}