Getting Started

API Keys

Before you get started, you need your client_id and client_secret credentials. To obtain your credentials, please contact our technical support team if you haven't already done this.

Authentication

Your API requests are authenticated using API access token. Any request that doesn't include an access token will return an error. Authenticate your requests using a valid bearer authentication header.

To get an access token, call the following endpoint using client_id and client_secret.

Get an API access token

POST https://<AUTH_SERVER_URL>/realms/nibela/protocol/openid-connect/token

Headers

Name	Type	Description
Content-Type*	string	The content type with value "application/x-www-form-urlencoded"

Request Body

Name	Type	Description
grant_type*	string	The grant type with value "client_credentials"
client_id*	string	The identifier for your client
client_secret*	string	The secret for your client

cURL

curl -X POST 'https://${AUTH_SERVER_URL}/realms/nibela/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=${YOUR_CLIENT_ID}' \
--data-urlencode 'client_secret=${YOUR_CLIENT_SECRET}'

200: OK Successful response

{
  "access_token": string,
  "expires_in_sec": integer,
  "type": string
}

401: Unauthorized Permission is denied

400: Bad Request Request is malformed

500: Internal Server Error Something is not working on our side

AccessTokenResponse

For more details, please refer to the Authentication page.

Authentication

Make your first request to our API

To make your first request, send an authenticated request to the /health/ready endpoint using a valid bearer access token as follow:

Check system health

GET https://<API_SERVER_URL>/health/ready

Headers

Name	Type	Description
Authorization*	string	The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"
Content-Type*	string	The content type with value "application/json"

200: OK Successful response

{
  "status": string
}

500: Internal Server Error Something is not working on our side

401: Unauthorized Permission is denied

400: Bad Request Request is malformed

curl

curl 'https://${API_SERVER_URL}/health/ready' \
--header 'Authorization: Bearer ${YOUR_ACCESS_TOKEN}' \
--header 'Content-Type: application/json'

All Done!

Congratulations on making your first call to the Nibela system!

Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with our APIs.

API Reference