API Authentication
The Appcircle API supports authentication with a Personal API Token. The token for each user will have the same permissions with the user within the organization and each organization require a separate Personal API Token.
Alternatively, the Appcircle API also supports authentication with an API Key. API Keys are typically used for service-to-service or automation scenarios where the authentication is not tied to an individual user. Each API Key is associated with an organization and can be managed from the organization's security settings.
You can generate your Personal API Token or API Key within the security section of the Organization module.
- For detailed information on Personal API Tokens, please refer to Personal API Token documentation.
- For API Keys, please refer to API Keys documentation.
Using the Token for API Authentication
For authentication, you need to generate a session token from the Auth API using the Personal API Token and add the generated session token value along with an Authorization header in all API requests.
A curl-based API call sample is as follows:
First generate an authorization token using the Auth API with the Personal API Token specified as "Personal-API-Token":
curl -X POST "https://auth.appcircle.io/auth/v1/token" -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "pat=Personal-API-Token"
Then use the generated auth token specified as "Auth-Token-Goes-Here":
curl -X GET "https://api.appcircle.io/distribution/v2/profiles" -H "accept: application/json" -H "Authorization: Auth-Token-Goes-Here"
API Documentation
Access the full API documentation and explore the endpoints available for your integration needs at:
