After July 2021, the 2.3.x release line will no longer receive quality updates, or user guide updates. PHP 7.3 reaches end of support in December 2021 and Adobe Commerce 2.3.x reaches end of support in September 2022. We strongly recommend planning your upgrade now to Adobe Commerce 2.4.x to help maintain PCI compliance.

API Users

The information on this page is intended for Adobe Commerce 2.3 customers who are on an extended support contract. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.

The API allows developers to establish integration with other systems, and automate tasks. The dotdigital 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.

    dotdigital - 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.

    dotdigital - manage users Manage Users

The new API user is added to the Access list.

dotdigital - API users list API Users List