Public API
Creating an API User in ezManage
2min
The first step in connecting to the Public API is to create a specific user for it within ezManage.
- Go to "Users & Permissions" within the Settings tab of ezManage, then select "Add New User."
- Input key information about the user. If you are using a third party integrator, we recommend that the first name be the integrator (for example: Checkmate, QuBeyond) that you are working with and the last name be API.
- For the email, ask your integrator to create a unique email address for your brand, which they can receive the ezManage invitation at and log in to generate the API Token. Most integrators use a format similar to: [email protected] depending on their email provider. If you are not using a third party integrator, or are unable to use the recommended, please reach out to [email protected] to discuss potential alternatives.
- Next, select which stores your integration should have access to. All locations associated with the user will be available to the integration. Note: These users should have access to at least one location.
- Once the locations have been selected, click "Select". The stores you selected will populate the table.
- Click "Send Invitation" at the bottom of the page to create your API user.
Once the integration partner has accepted the invitation, you will be able to grant them the permission needed to generate their integration credentials.
- Go to "Users & Permissions" within the Settings tab of ezManage, then select the API contact you created.
- Once on the API contacts page, select the “Permissions” tab from the top navigation.
- Scroll to the bottom and you should see an “Integrations” option.
- Toggle on “Authorized to create credentials for external integrations”
Granting Integrations permission will disable any other permissions for this user.
Updated 11 Oct 2024
Did this page help you?