API Users

The API allows developers to establish integration with other systems, and automate tasks. The Engagement Cloud API version 2.0 web service supports both REST and SOAP.

As a best practice, it is recommended that you create one API user per supported system. For example, having only one API user for your Magento integration makes it easier to isolate and diagnose problems, and change privileges.

Only the account owner or another user with the “Can manage account” permission can create API users. To learn more, see Getting started with the API.

Add an API User

  1. Click the Settings ( Settings icon) icon at the bottom of the sidebar. Then on the menu, choose Access.

  2. On the Access page, choose the API users tab.

    Engagement Cloud - API users API Users

  3. Click New user. Then, do the following:

    • Accept the randomly-generated Email address. Each API user must have a unique email address.

    • In the Description field, describe how the account is to be used.

      Because this field appears in the list after the randomly-generated email address, it should make the user easy to identify.

    • Click the password field, and enter the password for the user. Then, enter the password again to confirm.

    • Verify that the Status Enabled option is selected.

  4. When complete, click Save.

    Engagement Cloud - manage users Manage Users

The new API user is added to the Access list.

Engagement Cloud - API users list API Users List