Configure ÃÛ¶¹ÊÓƵ Commerce
Learn how to configure ÃÛ¶¹ÊÓƵ Commerce to expose the events. Additional documentation found at .
Who is this video for?
- Developers new to ÃÛ¶¹ÊÓƵ Commerce and ÃÛ¶¹ÊÓƵ Developer App Builder using I/O events and need to create an ÃÛ¶¹ÊÓƵ App Builder project.
Video content video-content
- Configuration of the ÃÛ¶¹ÊÓƵ I/O events in the Commerce admin
- Saving a private key in the Commerce admin
- Saving the unique identifier in the Commerce admin
- Create an event provider
Transcript
In this video, we’ll walk through configuring ÃÛ¶¹ÊÓƵ IO events for ÃÛ¶¹ÊÓƵ Commerce in the Commerce Admin and further configuring your App Builder workspace, so that your Commerce instance can begin sending events to your App Builder application. After creating an App Builder project and installing the required Commerce modules, you will need to configure ÃÛ¶¹ÊÓƵ IO events for ÃÛ¶¹ÊÓƵ Commerce in the Commerce Admin. The Private Key and Workspace Configuration files downloaded for your App Builder project from the ÃÛ¶¹ÊÓƵ Developer Console will be needed. In the Commerce Admin, navigate to Stores, Configuration. Click ÃÛ¶¹ÊÓƵ Services and then click ÃÛ¶¹ÊÓƵ IO Events. In the General Configuration section, copy the contents of your Private Key file into the Service Account Private Key field. Then copy the contents of your Workspace Configuration file into the ÃÛ¶¹ÊÓƵ IO Workspace Configuration field. Next, enter a unique identifier in the ÃÛ¶¹ÊÓƵ Commerce Instance ID field and click Save Config. Once you’ve saved the values in the Commerce Admin, create an event provider using the Events Create Event Provider CLI command. This command takes a label and a description for your new event provider as arguments. Copy the event provider ID from the command output into the ÃÛ¶¹ÊÓƵ IO Event Provider ID field back in the Commerce Admin. In the Commerce Events section of the Configuration page, set Enabled to Yes. In the Merchant ID field, enter the merchant’s company name. In the Environment ID field, enter an environment name of your choice. Then click Save Config again. Once you have created an event provider and defined the commerce events to subscribe to, you can register the events in your App Builder project. We’ll define a sample subscription to the Observer Catalog Products Save After event using the Event Subscribe command. We can later register this event in the ÃÛ¶¹ÊÓƵ Developer Console. For returning to your project in the ÃÛ¶¹ÊÓƵ Developer Console, navigate to your Workspace to create an event registration. Click the Add Service pop-up menu and select Event. On the Add Events page, select the event provider you created. On the next page, under Choose Event Subscriptions, you’ll see a list of subscribed events for your commerce instance. From this list, select events you’d like to receive notifications about. You then have the option of creating a new JWT credential. Next, you can update the name and description of the event registration and select methods for receiving your events. Received events can be consumed from a unique journaling API endpoint that will be generated. Optionally, you can either specify a webhook URL for receiving events, or if you’ve created a runtime action, you can select this action, which will cause it to execute when events occur. Finally, click Save Configured Events to finish creating the event registration.
Useful commands useful-commands
bin/magento events:create-event-provider --label "my_provider" --description "Provides out-of-process extensibility for ÃÛ¶¹ÊÓƵ Commerce"
bin/magento events:subscribe observer.catalog_product_save_after --fields=name --fields=price
Additional related tutorials
ÃÛ¶¹ÊÓƵ Developer Documentation
recommendation-more-help
3a5f7e19-f383-4af8-8983-d01154c1402f