Guides

Getting Started

Suggest Edits

Welcome to the SCALAR developer portal 👋

The portal provides you with the information to integrate the power of SCALAR into your apps.
Please follow along to get started with SCALAR integration .

Introduction

SCALAR provides thoughtfully designed HTTPS REST API endpoints for integration. The API request and response use application/json content type.

This page is a quick start for using the SCALAR APIs and building your first integration.

SCALAR Registration

You need SCALAR integrator credentials to build an integration. Integrator is a developer account that allows you to call SCALAR APIs. To learn more about Integrators please refer Authentication.

To register and receive an integrator, please contact your SCALAR representative.
You would be provided a SCALAR Integrator ID and Secret for you to start working with SCALAR APIs.

Get Token to call APIs

SCALAR API uses bearer Token HTTP authentication scheme. To get a token call https://auth.api.eu1.scalar.zf.com/v1/integrators/token with Integrator ID, Secret, and Audience passed in the Request body.
The concept of Audience is explained in the next section below.

{
  "clientId": "string",
  "clientSecret": "string",
  "audience": "string"
}

After a successful API call, you will receive an access token as part of the API response. The Response schema is shared below.

{
  "accessToken": "string",
  "expriesIn": 0,
  "tokenType": "string"
}

Please Note: The access token will expire every 1 hour. So once your token expires, you need to call the token endpoint again to get a new token. You can reuse the token as much as you want during that time period.

What is an Audience?

Audiences are used to put the relevant permissions into the token. Each product is mapped to an audience and when requesting a token it is vital that the correct audience is requested so the correct permissions are uploaded in the token.

To learn more please refer to Authentication & authorization.

Try an API

In order to use the access token, include it in the Authorization header in your HTTP request.

curl --request GET \
     --url https://trailer.api.eu1.scalar.zf.com/v1/assets \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

This call should return a list of assets in your organization.

🎉 Congratulations on your first API call.
You are now ready to start building with SCALAR.

Learn more about SCALAR APIs

Updated about 1 month ago

What’s Next