HomeTutorialsAPI ReferenceUpdates
Tutorials

Create a Personal API Key

❗️

Create Dedicated Users and Groups

Personal API Keys inherit all permissions granted to the user that created the key. This includes the permissions from all groups the user belongs to.

For security and clarity, we strongly recommend you create new users and groups tailored to each specific task requiring an API key. Assign only the permissions necessary to complete each task.

Users can create Personal API Keys to authorize API requests made programmatically (outside of the OptiPub Web Console). API keys can authorize automations and other custom bulk actions created by your development team to read or write to OptiPub. Any external services that communicate to OptiPub will require an API Key to authorize their requests.

Currently only Administrators can create API Keys.

Please Remember to Remove the User from the Administrators Group after creating an API Key

The API Key permissions will always match and update with the permissions of the user.

How to Create a Personal API Key

(Optional) Create New User and Group

  1. Create a new User.
  2. Create a new Group.
  3. Assign Permissions to the group needed to process your API requests.
  4. Add user to necessary groups and temporarily add them to the Administrators group.

Create API Key as User

  1. Sign into OptiPub as the user that has permissions you want to give the API Key.
  2. Click the User's Name > Preferences at the top of the left navigation menu.
  3. Select API Keys in the preferences menu.
  4. Click Create New Token
  5. Enter a Name for the token and click Create
  6. A card displaying the created token key will appear.
  7. - IMPORTANT - Copy the token and save it in a secure location. The token is not recoverable once the displayed token is closed.
  8. Click Close

Remove user from Administrator group

  1. - IMPORTANT - Remove the user from the Administrators group.

You now have an active API Key. Check out our API Reference documentation.


API Key Expiration

Personal API Keys have a 1 year expiration date. Once expired any requests made with the key will not authorize and will return a 403 Forbidden Error.

Updated 19 days ago