Learn how to set up an API user to enable you to make use of the Dotdigital API.
An API user allows you not only to make direct use of our API, it is also a necessary step in the installation of our integrations such as Magento or Microsoft Dynamics.
Each API user has its own credentials(a username and password) that must be used to authenticate an operation or call.
Before you start
Things you need to know:
- Only an account owner or admin user (a user with the Can manage account permission) can add API users. You can find out more about amending user permissions in the Restrict and grant user access permissions article.
- You can have more than one API user in a Dotdigital account.
Create a new API user
Multiple API users
When creating API users, it's best practice to create one user per system — for instance, one for a Magento integration and another one for a Dynamics integration — and not share an API user for different purposes.
We advise this so that it's easier to revoke individual API users should you need to, as well as isolate and diagnose problems with integrations.
- Go to Settings (⋮) > Access > API users
- Select NEW USER.
- The username (email address) is automatically generated for you and must not be edited. You can also add a description.
The Description field is most commonly used to help you identify the purpose of an API user, so you might enter something like Magento Production or Dynamics CRM. This is particularly useful when you have multiple API users in a single account.
Enter a password and confirm it. Your password must be at least eight characters in length and contain at least one digit or non-alphanumeric character. Please avoid including your email address or company name as part of your password.
It’s also not possible to use the word password as part or all of the password for your API user.
- Select Enabled.
- Select SAVE.
The API user is now ready to use.