Configure Catalog API
Follow these steps to configure the Catalog APIs for your Just Walkout store
Access the Catalog API setup wizard
- Step 1: Navigate to the Catalog Management tab in the Merchant Portal.
- Step 2: Click on the Catalog tab, this will open up the Catalog Home Screen
- Step 3: Click on the Catalog API Setup tab
Once the user navigates to Catalog API Setup tab in the Catalog Home Screen, the user will be guided through a widget 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 by step process
- Step 1: AWS Account Setup Step
- Step 2: AWS Resources Setup Step
- Step 3: Provide Configuration Values
The user will see a AWS Account Id that is allowlisted to invoke Catalog APIs, SQS ARN that is configures to receive Catalog Upload status notifications, and a list of stores associated with the merchant account that are authorized for Catalog APIs, as well as Connectivity Status and SQS Subscription Status. The user will be able to edit configurations by following the instructions in this document
Connectivity Status:
- Unknown: Connectivity Testing has not been initiated or has failed.
- Success: Connectivity Testing is successful and the AWS Account Id is able to call Catalog APIs for all the stores associated with merchant account.
SQS Subscription Status:
- Unknown: SQS subscription request has not been sent to merchant SQS queue.
- Pending: SQS subscription request has been sent to merchant SQS queue and is waiting for confirmation.
- Complete: SQS subscription has been created successfully.
Setting up Resources
Once at the AWS Resources Setup Step the customer can decide to setup new resources like SQS and Connectivity Testing lambda on their account. They can choose to skip the following sub steps if they already have an account and SQS Queue onboarded to Catalog API.
- Step 1: Click on the Documents section
- Step 2: Open Developer Kit Folder and download CFN templates SQSSetupTemplate.yaml, ConnectivityTestTemplate.yaml and Checksum file Checksum.txt.
- Note: You are provided with a Checksum.txt file that will provides the sha256 hash for ConnectivityTestTemplate.yaml and SQSSetupTemplate.yaml files. You can choose to match these hashes to the respective files and verify if they have been tampered before you deploy them to your account.
SQSSetupTemplate.yaml: Once deployed in your account will create a SQS queue named JWOCatalogIngestionStatusQueue with the correct set of policies to receive notification for Catalog Upload. This will also create a Lambda function named SubscriptionConfirmationLambda that you can use to easily subscribe to receive notifications on the aforementioned queue. DO NOT change the name of the queue or alter its policies in anyway as this will cause the Lambda function to fail.
ConnectivityTestTemplate.yaml: Once deployed in your account, this file will create a Lambda named ConnectivityTestingLambda. The user can trigger this lambda function to check whether the AWS account configured has been authorized to invoke Catalog APIs successfully. Further testing is required to ensure the end-to-end use case
Step 3: Deploy SQSSetupTemplate.yaml CFN template in your account steps below Step 4: DeployConnectivityTestTemplate.yaml CFN template in your account using the steps below.
Deployment steps:
- Login to your AWS account console that you would like to onboard to Catalog API.
- Open the AWS CloudFormation console at https://console.aws.amazon.com/cloudformation.
- On the navigation bar at the top of the screen, choose the AWS Region to create the stack in.
- On the Stacks page, choose Create stack at top right, and then choose With new resources (standard).
- On the Create stack page, choose Choose an existing template under Prerequisite - Prepare template.
- Under Specify template, select Upload a template file, and click Choose File to upload the CFN template from your local system.
- Choose Next to continue and to validate the template.
- On the Specify stack details page, type a stack name in the Stack name box.
- Choose Next to continue creating the stack.
- Scroll to the bottom of the Configure stack options page and choose I acknowledge that this template may create IAM resources to specify that you want to use IAM resources in the template.
- Choose Next to continue.
- On the Review and create page, review the details of your stack.
- Choose Submit to launch your stack.
Onboarding to Catalog API
Step 1: While in your account, open the Amazon SQS console at https://console.aws.amazon.com/sqs/. Step 2: Click on JWOCatalogIngestionStatusQueue and copy the ARN for the Queue. You will require this ARN in the next steps Step 3: Come back to the Merchant Portal and back to Catalog API Setup, click on Next to move to Input API Connector. Step 4: Add AWS Account Id, SQS ARN obtained in Step 3.3 and check all the boxes for stores. This will authorize your account to call Catalog API for all these stores.
Step 5: Click on Save. Step 6: This brings you back to the home page, which will look like this
Note: After this step, your account has been allowlisted for all the stores that are displayed in the stores list. This has also sent a subscription request to your SQS that you will need to confirm to receive notifications on Catalog Upload. In case you are not able to confirm the subscription within 48hrs the request will expire and you will have to generate a new one by clicking the Resend Request button as shown above.
Confirming the Subscription
Step 1: Log in to your Allowlisted AWS Account. Step 2: Execute Step 2.1 to 2.4 from AWS Guide.
[OR]
Step 2: Open the Amazon Lambda console at https://console.aws.amazon.com/lambda. Step 3: Click on functions and then click on SubscriptionConfirmationLambda. Step 4: Click on the Test Tab.
Step 5: Click on the Test button on the top right corner.
Step 6: You will receive a success notification stating Subscription Confirmed successfully.
Note: At this point the Subscription has been confirmed successfully and you can go back to the Merchant Portal to view the status of the subscription.
Note: If it shows SQS Subscription Status to be Unknown even after successfully confirming the subscription, clicking on the Refresh Status button should make it show up as Complete.
Connectivity testing for Catalog APIs
Step 1: Log in to your Allowlisted AWS Account
Step 2: Open the Amazon Lambda console at https://console.aws.amazon.com/lambda
Step 3: Click on functions and then click on ConnectivityTestingLambda
Step 4: Click on the Test Tab
Step 5: Pass in a formatted request in Event JSON
{
"storeList": ["
Step 6: Click the Test button on the top right corner
Step 7: You will receive a success notification stating Connectivity testing successful, permissions configured correctly
At this point the Connectivity has been tested successfully and you can go back to the Merchant Portal to view the Connectivity Status.
