Required Python Dependencies
This connector requires the following Python library to be installed on the DataHub server:
•requests (for HTTP API communication)
One-Time Installation Required
Before using this connector for the first time, you must manually install the required Python dependencies.
Installation Command:
pip install requests
After Installation Steps
|
Important: You must restart DataHub services after installing dependencies. |
Windows:
1.Stop "DataHub Agent" and "DataHub" services via Services.msc
2.Start "DataHub" service first, then "DataHub Agent" service
3.Verify the connector functions correctly
Linux:
sudo systemctl stop datahub-agent datahub
sudo systemctl start datahub datahub-agent
API Key Configuration
Calls to the Cloud Academy API are identified by API keys. It is using the OAuth2 with client credential flow. Keep in mind that the SSL channel will securely encrypt the key pairs. In order to use the connector it is necessary to generate an API Key in the Cloud Academy environment.
API Key Generation
API Keys can be generated by enterprise members with Admin permissions. They can view their own API keys on the settings area of the Company Account. Each Admin has his own distinct key pairs. An Admin can generate new API Keys at any time. If a new pair is generated the previous pair is revoked.
API Call Authentication
To authenticate an API call a valid access token is needed for each request. It is possible to generate the token at the following dedicated endpoint:
https://cloudacademy.com/oauth2/token/
The token generation endpoint accepts a POST call and works using Basic Authentication where the user and the password to be provided are the API keys:
The username is the CLIENT_ID.
The password is the CLIENT_SECRET.
Additionally the API also requires the content-type to be set to 'application/x-www-form-urlencoded' and the body must contain 'grant_type=client_credentials'.
The token has a limited duration of 10 hours and can either be cached to be reused and renewed when it expires or a new one can be generated before each API call.
 |
Best practice: It is recommended to create a dedicated Admin account for the use with the connector. |