Authentication
The authentication system for users uses session-based authentication. This session token MUST be provided to
make authenticated requests to this service. An Authorization Header with an auth-scheme of BLN including auth-params type, version, entity, key, token and secret. Example: bln type=api, version=1, entity=user, key=<api-key>, token=<api-token>, secret=<api-secret>
An additional Header, training-provider-id, is also required to authenticate calls for APIs under the Training Provider category. Enter the training provider Id provided by our CS team in this field. This header is mandatory for all API calls under the Training Provider category, such as Instructor-led Classes and E-Learning.
However, for APIs under the Organization category (e.g., Export Data APIs), the training-provider-id is not required.
Please contact our CS team to get your API key, token and secret and training-provider-id (if needed).
Auth Parameters
| Parameter | Description |
|---|---|
| type | For user-based authorization, this parameter MUST be api. |
| version | Currently, only version 1 is supported. |
| entity | For user-based authorization, this parameter MUST be user. |
| key | An authorization key scoped to your organization |
| token | A login session token |
| secret | A secret access key scoped to the user |
Please note that the expected response time for some APIs can take up to 4 seconds.
Environments
The SkillPass External Training Provider API is hosted on two servers, one for the sandbox environment, and one for the production environment. The sandbox environment is used for development and testing.
- Sandbox URL: https://shared-tp-api-test.30a.dev
- Production URL: https://kube-prod.bluedrop360.com
Below is an example of how to change the server's base URL while using the API Reference:
The Sandbox environment is refreshed daily. Any data that has been created, modified, or deleted will be reverted after the refresh.