Configure Loyalty API
- Accessing the Connector Setup and Testing
- Completion Status
- Configuring Store Connectors
- Connectivity Testing
Accessing the Connector Setup and Testing
Navigate using steps below to configure store connector configurations
Step 1: Navigate to the Settings tab in the merchant portal
Step 2: Choose Connector Configurations under Developer Settings
Once you navigate to Connector Configurations in the Settings menu, you will be guided through a wizard that describes the necessary pre-requisites. The user can skip the instructions and will not appear again until the user clears the browser cache data.
Step 1: AWS Account Setup Step
Step 2: AWS Connector Creation
Step 3: Provide Configuration Values
The user will see a list of all stores associated with the merchant account based on the store type and applicable services for that store . The user will be able to add or edit store configurations for each service by following the instructions in this document
Note: making changes to store configurations will impact the store operations. Please follow your organization change management process to ensure only authorized personnel can make changes to the API endpoints
Completion Status
- Incomplete - one or more required values is not set
- Complete - all the required values are set. This does not mean all the connectors are working properly. Please refer to the onboarding documents to ensure all steps are completed to onboard store endpoints
- Not Required - the retail integration capabilities for the store are owned by Amazon and no action is required
Configuring Store Connectors
The user journey starts on the Connector Configurations page. For already configured methods like Identity, Loyalty, Ordering or Fraud and Abuse, you can either choose to run test against the endpoint or choose to edit the existing configurations.
Note: The user can modify a current configuration by clicking the pencil icon to edit the value or keep the current configuration by clicking on Cancel button.
If you run test without saving the endpoint first, the test will run against the previously configured endpoint. Based on the configured store capabilities the user will see options to configure the applicable connectors
The user will be required to provide two inputs for each endpoint to ensure successful communication between the Amazon systems and the company integration application. Endpoint (connector URL) and Endpoint Type (public or private API)
- Endpoint - A hostname for an API in API Gateway that is deployed to a specific Region.
- Endpoint Type - An API endpoint type refers to the hostname of the API. The API endpoint type can be edge-optimized, regional, or private. Depending on where the majority of the API traffic originates from. For more details on API types see AWS documentation.
Amazon Just Walkout services provide the ability to use Private or Public API endpoints. If you choose Edge-optimized or Regional AWS API GWs as the type of your end point, then you will need to select Public. Only Private AWS API Gateways need to be set as Private.
Connectivity Testing
The user will be able to perform connectivity testing after completing the connector configuration. Connectivity testing ensures that the Amazon systems can communicate with the company systems. Further verification and testing is required before launching a store to ensure appropriate operations. For complete list of onboarding processes please coordinate with the Amazon team.
Connector API URL - Endpoint URL provided as an input for the connectors. A hostname for an API in API Gateway that is deployed to a specific Region.
Type - API endpoint type which was chosen by you during configuration.
Status - This is the connector connectivity status. It can have below values:
-
Untested - The endpoint is saved recently and testing is not completed
-
Tested - This endpoint is tested and would have all the details of this under
View Detailsbutton.
Run Test - Triggers a request from the Amazon systems to the company configured connector endpoint.
