Welcome to the Amazon Yojaka (SmartConnect) Adapters Documentation
Welcome to the Amazon Yojaka (SmartConnect) Adapters Documentation¶
This guide will help you build an Amazon Yojaka Adapter service to expose an E-Commerce marketplace’s capabilities to the Amazon Yojaka product, and thus make that marketplace available for selling partners integraed with the Amazon Yojaka product through connector applications. This document will contain sections that will describe the authentication and authorization mechanisms, APIs and messaging mechanisms that will allow your adapter service to work with the Amazon Yojaka product.
How to get help¶
If you have any questions about Amazon Yojaka, how to develop a connector, or questions about any section in this guide, reach out to us via email at smartconnect-support@amazon.com.
What is an adapter?¶
An adapter is a service that integrates an E-Commerce marketplace with the Amazon Yojaka product. The adapter service has to adhere to an interface contract defined by the Amazon Yojaka product. This interface includes both synchronous RESTful APIs and asynchronous notifications published by the Amazon Yojaka product.
It is the adapter’s responsibility to handle transformations and mapping between the entities and processes defined by the Amazon Yojaka product, and those that are relevant to the marketplace supported by the adapter.
Overview¶
As an adapter developer, you have to adhere to certain interface contracts defined by the Amazon Yojaka product and implement these interfaces and processes appropriately. These include:
Invoke Amazon Yojaka adapter APIs - The Amazon Yojaka product exposes certain RESTful API interfaces which you, as an adapter developer have to invoke at appropriate instances. Refer to the Inbound APIs section for more details.
Expose a RESTful API - Your adapter must implement a RESTful whose interface is defined by the Amazon Yojaka product and expose this API endpoint on the internet using the AWS API Gateway service. Refer to the Outbound APIs section for more details.
Process asynchronous notifications - The Amazon Yojaka product raises notifications at various instances which your adapter will have to consume and process appropriately. These notifications are raised using the AWS Simple Notifications Service. Refer to the Notifications section for more details.
Quick Links¶
For quick access to Amazon Yojaka’s API documentation for an adapter, use the links below.
On this page
