Shopify policy

AShopify policy contains the connection details that are used by a Shopify Input or Shopify Request node when you connect to a Shopify application.

You can use a Shopify Request node in a message flow to connect IBM® App Connect Enterprise to Shopify and issue requests to add, delete, or retrieve objects such as customers, inventory items, orders, products, and transactions. You can use a Shopify Input node in a message flow to monitor changes in a Shopify application and accept input. The Shopify policy controls, at run time, access to the Shopify application and resources.

The Shopify policy is created when you configure a connection between a Shopify Inputor Shopify Request node and a Shopify account by using the Connector Discovery wizard. During the process of discovery, account credentials are stored in the vault and connection details are stored in a Shopify policy. The policy is created with a type of Shopify, and the name of the policy is returned to the Shopify Request node and specified in the Connection tab of the node, in the format {policyProjectName}:policyName.

You can also create, update, or delete a Shopify policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy a Shopify policy, all message flows that are using the policy are stopped and restarted.

For more information about using Shopify policies, see Using Shopify with IBM App Connect Enterprise.

Table 1. Properties of the Shopify policy
Property Property name in .policyxml file Description of properties
Shopify Application Type applicationType This property is reserved for future use and must be set to the value online.
Shopify Application Version applicationVersion This property is reserved for future use and must be set to the value v1.
Shopify Authentication method authenticationMethod You can select BASIC_API_KEY as the authentication method.
Store name accountName This property is the name of your store on Shopify. For example, in the URL your-store.shopify.com, your-store is the name of your store.
Credential Name credential This property specifies the name of the credential that is used for the connection to Shopify.

The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider.