Adding, editing and removing API keys

An API key in Inkit is much like a user. It gives applications and integrations the ability to make Inkit requests based on the roles you've assigned to the key. As such, you should create an API key for each of your systems that will be making API requests while giving it only the subset of permissions that it needs.

You can add, edit and remove an API key.

Adding an API key

To add an API key, do the following:

In the Inkit web app, click Settings in the left sidebar, then click on the Development tab and click + Create in the API Keys panel.
In the Create API Key dialog box, enter the Name of the API key, an optional Description of it and select its Roles & Access. To view permissions associated with the roles you have chosen, click View Permissions.

The These Permissions will be Granted to the API Key dialog box will display. To change the permissions, click Manage Permissions.

Finally, click Save.

You can now generate an API key.

Editing an API key

To edit an API key, do the following:

In the Inkit web app, click Settings in the left sidebar and then click on the Development tab. Next, in the API Keys panel, click on the ... menu button beside the API key you want to edit and click Edit.
In the Edit API Key dialog box, you can change the Name of the API key, an optional Description of it and its Roles & Access. To view permissions associated with the roles chosen, click View Permissions.

The These Permissions will be Granted to the API Key dialog box will display. To change the permissions, click Manage Permissions.

Finally, click Save.

Removing an API key

To remove an API key, do the following:

🚧
If you remove an API key, all your applications and integrations that use it will cease to function.

In the Inkit web app, click Settings in the left sidebar and then click on the Development tab. Next, in the API Keys panel, click on the ... menu button beside the API key you want to remove and click Remove.
In the Remove API Key dialog box, click Continue.