Introduction
Principa Cloud exposes several API's to programatically interact with various available features and services. All Principa Cloud APIs are organised around REST, using structured JSON request and response bodies.
Authentication and authorisation is performed using a standard Authentication endpoint.
Environments
A test environment is available for initial integration work. Once ready for production, you can switch to new production endpoints and API keys.
| Environment | Base URL |
|---|---|
| Test | https://api.staging.principa.cloud |
| Production | https://api.principa.cloud |
Getting Access
Step 1: Sign up to Principa Cloud
Accessing the Principa Cloud APIs will require your organisation to register with Principa Cloud. To request access, email hello@admit.credit and we will contact you shortly to set up your account.
Step 2: Generate API Keys
Generate credentials using the Principa Cloud Portal.
Step 3: Load Credit
Some API operations consume credits (e.g. scoring and lead purchases) creating assessments is free. These operations will be deducted from an API credit balance which is managed on the Principa Cloud Portal. See Loading Credits
Need Help?
Should require further information or assistance with the Principa Cloud API's, please email us at hello@admit.credit
Continue: Generating Credentials >>