API Keys

Overview

The GjirafaTech Captain API exposes the entire GjirafaTech Captain functionality via a programmatic interface. You can manage your account settings, configure services, and develop applications using the GjirafaTech Captain API. Using the GjirafaTech Captain API requires either an API token from an identity server or API key to authenticate the source of the API request. API key allows you to authorize access to specific GjirafaTech Captain services with limited permissions. You can create API keys in Organization Scope or in Project Scope. Each GjirafaTech Captain project can have up to 50 API keys associated with their GjirafaTech Captain account. You can assign a role with custom persmissions to the API key so you can limit its scope.

Generate API key

The below section summarizes the process of generating the API key:

To generate an API key:

1. Log in to the GjirafaTech Captain dashboard.
2. On the left navbar go to Security.
3. Click the API Keys tab.

4. Next to the Captain API keys, click the Generate New button. You will see the Create Api Key screen.
5. You have 4 configuration options to select from.

6. Give a name to your API Key.
7. Select the following Role you want to assign to the API Key.
8. Select the following Scope you want to assign to the API Key (Organization or Project).
9. Select a valid time interval in which the API Key is valid. This will make sure that the API key won't work after the specified interval.
10. Click on Generate API Key.
11. To use the API Key that you just created you should follow the below example.

View API Key

To retrieve your API key:

1. Log in to the GjirafaTech Captain dashboard.
2. On the left navbar go to Security.
3. Click the API keys tab.

4. Click on get API key button to retrieve your API Key.
5. After that, to authenticate your requests add x-api-key header to every request to GjirafaTech Captain Services with the value of the header being the API Key.