Site Administrators have the ability to create/update a user (account administrator) and specify which functional areas of the system should be exposed via API. If you are an Account Admin you must have the Settings > Account Administrators permission enabled for your admin record:
After the API user is created, you can use those credentials to access the appropriate API endpoints.
The process is the same as adding an administrator, the difference is adding permissions for API Access.
- Click Settings
- Click ‘Account Administrators’
- Click the (+) button, top right.
- Enter name, email address and password
- Email address should not be a personal or company address.* The email address should be:api@[yourURL]. For example, firstname.lastname@example.org.
- Password strength should be strong, and include numbers, letters, and at least 1 special character
- Click 'Accounts' tab > select applicable account(s) from left, move to right with the arrow
- Click 'Alerts' tab > configure any alerts for the new administrator to recieve
- Click 'Permissions' tab > select "View User" role on left, move to right with arrow
- Click API Access > Select all boxes for API SETTINGS
- Click 'Save'
* Email address should not be a personal or company address. Never create an API admin record under someone's personal address/admin record. If they leave the company, the admin record will need to be deleted which will invalidate the associated API calls. Please also note that this does not create a "live" email address -- it is purely an admin record.
What information you will need to authenticate your API calls:
You will need the following information to authenticate your API call(s)
- API email address
- API Admin's password
- Account List Name:
- To find your account list name, go to Settings > General Account Settings > Account Name: