API Keys

Included in Simplero plans: Scale and Skyrocket

An API key is like a login/password that other software applications use to interact with your Simplero account on your behalf using our API.

A Personal access key acts as one administrator and can do what that admin's role allows. A Full access key can change and delete anything in your account. Give keys only to software and people you trust.

Create a new API key for each situation so you can delete the ones you no longer need.

Adding an API Key

1. Go to www.simplero.com/go/admin/integrations.

2. Click Create new API Key.

3. Type a Purpose so you remember what the key is for, such as "Zapier" or "My website".

4. Select the Access type: Personal access or Full access.

5. With Personal access, select the administrator the key acts as in the Admin dropdown.

6. Turn on Read-only (only allow GET requests) if the key only needs to read data.

7. Click Create API Key.

8. Select Copy API key and paste the key where you need it.

The key is shown once. If you lose it, delete the key and create a new one.

The API Keys list shows each key's purpose, access type, admin, and read-only status.

Personal access or Full access

Choose Personal access unless the tool needs to act on the whole account.

• Personal access — the key can do what one administrator can do, based on that admin's role. It works with API v2 only. If you change the admin's role, the key's access changes with it. If you remove or disable that admin, the key stops working.
• Full access — the key can do anything in the account. It works with both API v1 and v2. Only the account owner and full-access admins can create Full access keys.

For tools that connect through API v2, create a separate administrator with a limited role and give the key Personal access acting as that admin.

Changing or removing a key

You can't change a key's access type, admin, or read-only setting after creating it. To change what a key can do, delete it and create a new one.

To delete a key, select the trash icon on its row in the API Keys list and confirm. Deleting takes effect immediately. Anything using the key loses access right away.

If you or your developer want to work with our API directly, see the API documentation at https://simplero.com/api/v2/docs.