Overview

The Cerbo API interface employs the Basic Authentication scheme, in which valid API user credentials must be included with each API call. You can create and manage API user credentials for accessing your data in Cerbo via the open API interface. 


Related Articles


Details

API user management is accessed in the Admin > Manage > Integrations menu. Select "API User Management" at the very top of the Integrations window. From here you can see a list of existing API user credentials and create new ones.


Add a new API user

Click the "+ Add a new user" button to create a new API user. You will first need to acknowledge your understanding of some facts and recommendations. All fields in the new user form must have a valid value entered before you can save the user.

  • Nickname: A descriptive name for the user. Consider a name that indicates the intended use of these API credentials, such as "Scheduling integration", "CRM sync", etc. 
  • Username/Public key: The username will always start with "pk_" and should include an alphanumeric word or phrase with no spaces or punctuation other than underscores _ or dashes - 
  • Permissions: The permission profile allows you to limit the endpoints that an API user has access to. We recommend that you grant lowest level / most restricted permission that still allows access to the necessary endpoints for the intended use of each set of credentials. This reduces the potential security risk if the credentials are compromised.
  • Primary Contact Email: This email address may receive important updates regarding the Cerbo API.
  • Brief Description: A short explanation of the intended use of the Cerbo API credentials, including any third party APIs that may be involved in the project.
  • Secret Key: Click the "Generate secret key" button to populate this field with a random key. Then click the "Copy secret key" link below the field to copy the key to your local system clipboard.
    Note: The Secret Key will not be visible again after you save the user, so be sure to copy it to secure storage before proceeding.


Edit existing API users

Existing API users will be listed by Nickname with the Username underneath. Click the pencil icon aligned with a user to edit the details. Note that existing users' Secret Keys will not be displayed.


Delete API users

Click the trash can icon aligned with a user to permanently delete it.