Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel1

Create an API Key

An API Key is a unique identifier and authentication key providing access to specific issuance and/or verification templates to your applications calling the Gataca Studio APIs.

Once you reach the end of creating an issuance template, you can select to add this template to an API Key. If you don’t have an API Key yet, you’ll have to create one in order to test your Template. The next steps show you how to create a new API Key.

On the left menu, click on API Keys section, and then click on New API Key and set the the “New API Key” button on the right hand side.

...

Set the API basic configuration:

  • API Key Name: Choose an identifier for your API Key

  • DID: Select the DID associated with the new API Key. This will determine which administrators will have access to this API Key (only those with permissions to manage the corresponding DID).

  • SSI Operations: Select the credential issuance template you want to associate with this API Key from the SSI Operations dropdown

...

  • .

...

You will be presented with the ID and password of the API Key created.

...

Info

Make sure to store the API key password in a secure place. Once you close this tab, you will not be able to retrieve the password, you will only be able to

...

How to add a template to an API Key

Once you reach the end of creating an issuance or verification template, you can select to add this template to an API Key.

When clicking on Add to API Key, a list of the available API keys for your templates will open.

...

  1. Select the API Key you want to associate with the new template created.

  2. Insert the password provided when creating the API Key.

  3. Callback: Insert the URL of a service that is notified by a post notification with the session data when the session has been validated.

...

regenerate a new password.

How to regenerate password for API Key

Go to API Keys and click on the three dots next to the API you would like to regenerate the password for. Click on Regenerate Password. A new password will immediately be generated.

Make sure to store the API key password in a secure place. Once you close this tab, you will not be able to retrieve the password, you will only be able to access the API Key ID in the API keys list.

...

Remove an API Key

Go to API Keys and click on the three dots next to the API you would like to remove from the list. Select Delete and confirm your decision.

...