Starter kit demo for back office integrations
Last update: Fri Apr 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
CREATED FOR:
- Intermediate
- Developer
Learn about the Adobe Commerce back office integration starter kit. This video tutorial shows the entire process for this sample integration.
Audience
- Anyone needing to understand this concept.
- Commerce applications that have a requirement to integrate their Adobe Commerce application with a back-end system
Video content
- Set up a project in the Adobe Developer Console
- Different workspaces
- Adding an API
- Types of authentication
- Adobe I/O Runtime service
- Configure I/O events
- Connecting to a third party to sync data
Transcript
Welcome to this starter kit demo. In it, we will show you how to integrate commerce with Sora subscription platform. We will start by creating a new project in the Adobe developer console. In order to create the project, we will create it from a template. It is the App Builder template and we fill in the required fields. This is the plate title and the application. Once we complete these steps, we will select one of the work spaces, in this case the stage, and we will add the required APIs for the integration to work. We will start by adding the IOManagement API. We will configure the authentication method. In this case, all server is preferred. Once we have done this, we will proceed to add the next API. The next API is the IOM events. We complete the process and we can add the last one. The last one is the Adobe IOM events for Adobe cover. Once we have created the project, we can proceed to the next step, which is adding a new integration in Adobe cover. This integration will enable incoming calls from the starter kit. We can navigate to integration and in this particular case, we have already created. Once we have the integration configured, we can proceed to the next step, which is downloading the starter kit and configuring it. We already downloaded the starter kit and we will start the configuration by copying the environment file and filling in the required details. The first block of details is the OAuth parameters from the commerce instance. It can be retrieved from the integration that we created in the previous step. The next set of values are the OAuth parameters from the developer console application. We will navigate to our app and copy them from there. The last bit of configuration are details about the consumer, the project and the worker space in the console application. Now that we have configured our project, we can proceed with its installation and connecting it to this developer console. In order to do that, we will start by installing the project dependencies. We are aware that this process can take a while if it’s time to install. Then we will log in into the developer console using the IO command line interface. Then we will select the organization that we want to use to deploy our project, as well as the project, the developer console and finally the workspace. Now that we have created the connection between our local project and the developer console, we are ready to proceed with our first deployment of the application. We will trigger the process from the command line using the Adobe IO key. And once it is completed, we will show all the different runtime actions that have been deployed. We can further confirm the deployment by checking them in the Adobe developer console. The starter kit includes an onboarding script that creates the providers, the metadata and the event registrations needed by the integration to work. It can be triggered from the command line and at completion, it will return some IDs that we will need to further configure the application. We can confirm the creation of the event providers and registration by checking in the Adobe developer console. Once we have onboarded the starter kit project, in the output, we receive some parameters that we need to configure the Adobe IO events modeling in commerce. These are mainly the commerce instance ID, Adobe IO provider and the workspace configuration. So in commerce, we navigate to the Adobe services, Adobe IO events module and we fill in the details that we got from the app. The next step is extending the existing code to propagate the creation of a product in commerce to a third party system, in this case, Swara. And the changes are mainly to find some environment parameters to connect with Swara, add logic to create an API token and implement the logic to use the Swara API to create a product. In this section, we will demonstrate how after deploying the changes, when a product is created in commerce, the changes will be replicated in Swara. So we create a product in commerce using the admin UI, we save the starter kit demo product, we see that the event has been received by Adobe console and then starter kit when receiving the event, we call the Swara API to create the product. Now we see the admin console in Swara, we go search for products, we see our starter kit demo product in the Swara console. In this section, we’re going to demonstrate the integration the other way around. So when a change happens in the third party system, how it gets propagated to this case, the third party system is Swara, provides what we call a workflow, which is a mechanism to listen to internal events and propagate the changes, performing a call to an external API. This case, the API that we’re going to call is the Adobe IOO events API. And in order to interact with it, we need to fill in certain details like the API key that we get from the developer console, the event provider ID that we get after the onboarding process has been run successfully, and so on. So here we are filling the required details. And we will see there won’t be any additional changes in Swara because we are using the event format that is suggested by the by the starter kit. So these are all the changes that we need to do. If we go to the product that was previously created from commerce, and we update the name, save the changes, we can see the event being received by the Adobe developer console, checking in the appropriate registration. Here we can see the payload. And we can see that the changes are according to what we did in the Swara site. And also we can see how the changes were propagated to commerce. That was all. Thanks for watching.
recommendation-more-help
3a5f7e19-f383-4af8-8983-d01154c1402f