API and CLI Authentication

The Appcircle API supports authentication with a Personal Access Token. The token for each user will have the same permissions with the user within the organization and each organization require a separate personal access token.

Generating/Managing the Personal Access Tokens

To generate a personal access token, go to the My Organization screen in the Appcircle dashboard. The personal access token section is located on the bottom left.

Press the "Generate Token" button to generate your first token.

The token will then be generated and displayed above. Please make sure that you save the token before navigating away from the page as it will be displayed only once for security reasons.

If you want to revoke a previously generated token, press "Revoke Token" and confirm. You can then generate a new token if you would like.

Using the Token for API Authentication

For authentication, you need to generate a session token from the Auth API using the personal access 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 access token specified as "Personal-Access-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-Access-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"

Using the Token for CLI Authentication

For authentication, you need to generate a session token from the Appcircle CLI using the personal access token and add the generated session token value as an environment variable

Using the Appcircle CLI, create a full access API token using the following command with the personal access token specified as "pat":

appcircle login ${pat}

Then copy the result and set it as the AC_ACCESS_TOKEN environment variable.

API Documentation

Please check the documentation to learn more about Appcircle API.