How to Generate an API Token for ScanX–Merchant Central Integration

Overview

An API token is required to connect ScanX with your Merchant Central instance. This article outlines the step-by-step process to generate the API token, which you can then provide to your ScanX implementation team.

Create ScanX API account

First, you'll need to create an account that will own the API token. We recommend creating a new user class to ensure that only the necessary permissions are granted to the ScanX API account:

ScanX API User Class

• Log in to your Merchant Central, navigate to Manage > User Classes and click Add New User Class:
  
  
  
  
• Navigate to the new User Class and click Permissions. Essentially, you can unchecked everything else except for:
  • Systemwide Leads and Unassigned Leads (My Leads)
    
    
    
    
    

  • API Access, Disable Automatic Logout and Disable User Login (Security)
    

• To give permission for ScanX to upload attachment, navigate to Manage > Documents > Labels. Search for Other (Original: Default) and click Permissions:
  
  

As the ScanX User Class is created with necessary permissions, you can proceed to the next step of creating the ScanX API account

ScanX API Account

• Navigate to Manage > User Accounts and click Add New User
• Fill out mandatory fields
  • Username: ScanXAPI
  • Email Address: we recommend using a generic internal company email rather than an individual’s, to prevent disruptions if that person leaves.
  • First Name: ScanX
  • Last Name: API
  • Mobile Number: This phone number will be used to receive SMS authorization codes
• Create Password: uncheck “Send temporary password” and  create a password for this account. 

Once done, you will be brought back to the Manage User > ScanX API window. Stay there to proceed with the next steps.

Generate an API Token

• From the Manage User > ScanX API window, click Edit User 
  
  
  
• Navigate to API Settings > click Create New API Token
  
  
  
• Add Token Name: ScanX
  
  
• Check the box “Restrict API usage to the provided IP addresses” and enter the ScanX IP addresses. These addresses will be provided to you by the ScanX team. If you don’t have them yet, please contact your ScanX Implementation team for the details.
  
  
  

Share the API Token with your ScanX team

Your ScanX team will collect the API token through a secure form. Please notify us when you're ready to share the token, and we’ll send you the form.