Getting Started
To use the BICS REST API, you must authenticate with an Authentication Token. BICS uses JSON Web Tokens (JWTs) as the authentication token.
You can retrieve this authentication token using an application token generated in your BICS account.
The following pages cover the authentication basics, querying resources, and how to create and use application tokens for automating or scheduling recurring tasks.
Authentication
When the /api/v1/authenticate
API is sent an application token, it returns an auth_token
used to authenticate all subsequent calls to the API via the Authorization
header.
JWTs
JSON Web Tokens (JWTs) are a secure mechanism to authenticate all API calls via the Authorization
header. This page describes how to obtain a JWT auth_token
and how they are used in requests.
Warning: Historically, you could retrieve the authentication token in two ways: with your user credentials (username and password) or an application token. To improve security across our services, authentication with user credentials has now been deprecated. Please authenticate with application tokens instead.
See the deprecation notice for more information about why BICS is making this change.