@adaas/a-os
v0.0.16
Published
The SDK to interact with a-os API
Downloads
2
Maintainers
Readme
a-os SDK
| LTS | Latest | npm | |---------------|----------|---------------------------| | v1.0.0 | v1.0.1 | @adaas/a-os |
Table of Contents
Quick Start
Step 1: Install SDK
cd /your/project/location
adf
npm i @adaas/a-os
Step 2: Provide Credentials
You can pass credentials through ENV variable or via code:
BASH
# Mandatory
ADAAS_API_CREDENTIALS_CLIENT_ID=ADAAS--client::769e6cb6597b...YOUR_ID...911f3060c161
ADAAS_API_CREDENTIALS_CLIENT_SECRET=ADAAS--secret::5ca6204b...YOUR_SECRET...e90c00a263f4db
In APPLICATION
const ADAAS_API_CREDENTIALS_CLIENT_ID = process.env.ADAAS_API_CREDENTIALS_CLIENT_ID!;
const ADAAS_API_CREDENTIALS_CLIENT_SECRET = process.env.ADAAS_API_CREDENTIALS_CLIENT_SECRET!
ADAAS_A_AUTH_Context.setCredentials(
ADAAS_API_CREDENTIALS_CLIENT_ID,
ADAAS_API_CREDENTIALS_CLIENT_SECRET
await ADAAS_A_AUTH_Context.authenticate();
Step 4: Start Using
By installing this app into your application then you will be able to access the ADAAS API or ADAAS products API via SSO
Environment Variables
| Variable Name | Required | Description | |---------------|----------|---------------------------| | ADAAS_API_CREDENTIALS_CLIENT_ID | YES | Your ADAAS API Credentials Key. Not mandatory in case when it's provided through the code | | ADAAS_API_CREDENTIALS_CLIENT_SECRET | YES | Your ADAAS Api Credentials Secret Not mandatory in case when it's provided through the code | | ADAAS_A_AUTH_CONFIG_SDK_VALIDATION | NO | Allows to ignore configurations validation | | ADAAS_A_AUTH_CONFIG_VERBOSE | NO | Allows to turn off extra library logs | | ADAAS_A_AUTH_CONFIG_IGNORE_ERRORS | NO | Allows to ignore error |