Admin user only
Only Admin users with Edit Account Settings and Data set as On can generate API tokens. You can do this via the “Settings > API” screen. Each token can have read or write scopes, has an optional expiry date and is tied to a specific account (not a user).
Before you take on the following steps, please make sure you have the right level of permission.
Use your test account
Runn has a neat feature called the "Test Account," which allows you to safely experiment on a copy of your Runn account.
We strongly recommend testing any integration in your test account first. If anything goes wrong in the integration, you can reload the data and test again, while all the data in your live account remain intact.
Switch to your test account
Click on your profile icon in the top-right corner
Selecting Switch to test account
Copy live data on the top purple banner to copy all the data from your live account into your test account.
Creating a Runn API Token
Click on your profile icon in the top-right corner
ClickSettings
Click API
Click Create API Token and confirm your read, write, expiry settings.
Your new API token is only shown once when it is generated.
You can also revoke access to the token from this screen.
You can tell if your API token is for your test account because it will start with TEST_
.
You use an API token with your live account, switch back to your live Runn account and generate an API token there. You will know you are using a live API token if it starts with LIVE_
.
See the Runn Developer Center to learn how to use the Runn API with your account.