Cloudformation templates for Just Walk Out onboarding
Overview
HAQM offers customers a range of flexible integration options to suit various organizational needs. When implementing these integrations, it's crucial to adhere to security best practices. It's imperative that organizations carefully review these options and consult their internal processes to ensure they select and implement integrations that align with their security requirements and best practices.
Available APIs
Identity API
For more details on the identity API please see the shopper entry experience spechere
eu-west-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
us-east-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
us-west-2 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
Ordering API
For more details on the ordering API please see the charge calculation spechere
eu-west-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
us-east-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
us-west-2 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
ap-southeast-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
Fraud and Abuse API
For more details on the Fraud and Abuse API please see the Risk Management spechere
eu-west-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
ap-southeast-1 region
API Processor | API Type | Download Link |
---|---|---|
HTTP | Regional | Click here to download |
HTTP | Private | Click here to download |
Lambda | Regional | Click here to download |
Lambda | Private | Click here to download |
Custom Lambda | Regional | Click here to download |
Custom Lambda | Private | Click here to download |
Deployment steps
Custom lambda stack deployment
Sign in to the AWS Management Console and select the button to launch the name of the AWS CloudFormation template.
- On the Specify stack details page, assign a name to your solution stack. For naming character limitations, refer to AWS Stack Names in the AWS User Guide.
- Under Parameters, review the parameters for this solution template and modify them as necessary. This solution uses the following default values.
Parameter | Description |
---|---|
HAQMOrderingConnectorAPIGateway IntegrationEndpoint | The CloudFormation template requires an input to run successfully. Before running the CloudFormation template, you will need to create a lambda function. Once the Lambda is created, you will also need to capture the ARN for the new function. For instructions on how to capture the ARN for the new function, you can get the Lambda ARN through the AWS console. To create the final input, replace values below with the values you have created: arn:aws:apigateway: |
- Choose Next.
- On the Configure stack options page, choose Next.
- On the Review page, review and confirm the settings. Check the box acknowledging that the template will create an AWS Identity and Access Management (IAM) resources.
- Choose Create stack to deploy the stack.
You can view the status of the stack in the AWS CloudFormation Console in the Status column. You should receive a CREATE_COMPLETE status in approximately five minutes.
Custom HTTP Integrations deployment
Note: HAQM expects that you to have created an API endpoint that will receive the JSON payload and forward it to a function to process the logic to respond to the API call.
HAQM require that you to create an API endpoint and host the API at an accessible URL. This automated AWS CloudFormation template deploys the solution in the AWS Cloud. You must complete the prerequisites before launching the stack.
Note: You are responsible for the cost of the AWS services used while running your App Full solution. For more details, visit the Costs section in this guide, and refer to the pricing webpage for each AWS service used in this solution.
Use the following steps to deploy this stack to your host AWS account:
- Sign in to the AWS Management Console and select the button to launch the name of the AWS CloudFormation template.
- On the Specify stack details page, assign a name to your solution stack. For naming character limitations, refer to AWS Stack Names in the AWS User Guide.
- Under Parameters, review the parameters for this solution template and modify them as necessary. This solution uses the following default values:
Parameter | Description |
---|---|
HAQMOrderingConnectorGetShopperAPIGWIntegrationUri | API EndPoint for the function |
HAQMOrderingConnectorGetShopperAPIGWIntegrationUri | API EndPoint for the function |
- Choose Next.
- On the Configure stack options page, choose Next.
- On the Review page, review and confirm the settings. Check the box acknowledging that the template will create AWS Identity and Access Management (IAM) resources.
- Choose Create stack to deploy the stack.
You can view the status of the stack in the AWS CloudFormation Console in the Status column. You should receive a CREATE_COMPLETE status in approximately five minutes.
Full Lambda Integration stack deployment
Note: The CloudFormation template will deploy the Lambda function based on the Lambda source code zip file in this integration model.
Use the following steps to deploy this stack to your host AWS account:
- Sign in to the AWS Management Console and select the button to launch the name of the AWS CloudFormation template.
- On the Specify stack details page, assign a name to your solution stack. For naming character limitations, refer to AWS Stack Names in the AWS User Guide.
- Under Parameters, review the parameters for this solution template and modify them as necessary. This solution uses the following default values:
Parameter | Description |
---|---|
LambdaHandler | The Lambda function handler is the method in your function code that processes events. When your function is invoked, Lambda runs the handler method. When the handler exits or returns a response, it becomes available to handle another events |
LambdaMemorySize | Memory size allocation for connector lambda code in MB. You can allocate any amount of memory to your function between 128MB and 3008MB, in 64MB increments |
LambdaRuntime | Runtime for connector lambda code |
LambdaS3Bucket | S3 bucket name for connector lambda code |
LambdaS3Key | S3 key for connector lambda code. please include full path to the zip file |
Choose Next.
- On the Configure stack options page, choose Next.
- On the Review page, review and confirm the settings. Check the box acknowledging that the template will create AWS Identity and Access Management (IAM) resources.
- Choose Create stack to deploy the stack.
You can view the status of the stack in the AWS CloudFormation Console in the Status column. You should receive a CREATE_COMPLETE status in approximately five minutes.