Preparing Your Account

Before you can start integrating with our APIs or using our SDKs, you need to prepare your account with the necessary access and configuration. This includes creating a service user, assigning proper permissions.

Creating a Service User

A Service User is a non-human user intended for API interactions. It's typically tied to your integration and used to authenticate API requests.

To create a service user:

1. Navigate to Console > Users

2. Click Add User and choose Service User as the type

3. Provide a name like integration-user

4. Generate an API Key for this user

5. Save the token securely, you’ll use this to authenticate your requests

Important: Store the API key securely. It won't be shown again. You can always revoke or regenerate it later.

Assigning Permissions

Service users need permissions to access specific APIs and resources.

To assign permissions:

1. Go to Console > Roles

2. Create or choose an existing role.

3. Grant necessary permission for the services you'll use.

4. Assign the role to your service user

Obtaining Organization Key

To authenticate your API requests, you'll need your Organization Key, which uniquely identifies your organization within our platform.

To find it:

1. Go to Console > Settings.

2. Select the General tab.

3. Locate the Organization Key field, copy this value for use in your API requests.

Sandbox Enrollment

If you're not yet subscribed to a production plan and you want to become a partner, you can use our Sandbox Environment to test and develop your integration.

Learn more on this page:

Becoming a Partner