Configurer les Webhooks

Important

Tout ou partie de cette fonctionnalité est accessible dans le cadre d’une version préliminaire. Le contenu et la fonctionnalité sont susceptibles d’être modifiés.

Les webhooks doivent être configurés pour sept entités spécifiques : UserGroups, Categories, Users, UserGroupAssignments, Addresses, AddressAssignment, Catalogs. Cet article vous guide à travers les étapes pour configurer et activer les webhooks pour le connecteur Sitecore OrderCloud.

Étape 1. Configurer les webhooks sur le portail OrderCloud

Cette étape nécessite de spécifier la source de chaque webhook pour garantir leur configuration correcte.

1. Accédez à Portail OrderCloud > Console API > Configurations de la livraison > Intégrations POST/deliveryconfig. Complétez le nom comme WebhooksDeliveryConfig, marquez comme activé.

2. Faites défiler vers le bas et recherchez Event Hub. Complétez le nom et la chaîne de connexion à partir de la source Eventstream OrderCloud. Cliquez sur Envoyer. Notez l’ID de configuration de la livraison.

3. Accédez à Webhooks, sélectionnez l’éclair dans le coin supérieur gauche et passez à la vue classique.

4. Pour chacune des sept entités, vous devez créer un webhook. Pour chaque webhook, sélectionnez le point de terminaison du webhook POST et complétez le nom.

5. Remplacez par le JSON fourni dans le JSON pour les webhooks pour chaque webhook.

6. Complétez l’ID client API et l’ID de configuration de la livraison corrects.

Étape 2. Configurer les webhooks sur le connecteur

Cette étape nécessite de spécifier la destination de chaque webhook pour garantir leur configuration correcte.

1. Accédez à votre ressource Webhooks Eventstream.

2. Créez une nouvelle source d’application personnalisée appelée OrderCloud.

3. Créez une nouvelle destination pour chacune des sept entités.

4. Sélectionnez Lakehouse comme nouvelle destination.

5. Dans les champs Nom de la destination et Table delta, entrez le nom de l’entité (Catégories, par exemple).

6. Saisissez le nom Lakehouse bronze créé et le nom de l’espace de travail associé.

   

7. Répétez ces étapes pour les six autres entités.

8. Une fois que vous avez créé les sept destinations, sélectionnez Désactiver tout.

Étape 3. Activer les webhooks configurés

Une fois la source et la destination des webhooks configurées, vous devrez les activer pour que les webhooks soient déclenchés à chaque mise à jour des données. Maintenant, pour lancer le flux de données, vous devez déclencher le webhook. Par exemple, vous pouvez créer une nouvelle catégorie du côté de la source et observer sa réplication du côté de la destination.

1. Revenez à la source Eventstream.

2. Sélectionnez l’icône de vague pertinente pour un webhook dans leur zone (Catégories, par exemple) et organisez les filtres.

3. Répétez les étapes pour déclencher les six autres webhooks. Vous pouvez voir les entités organisées dans la section Entités organisées .

4. Sélectionnez Activer tout. Maintenant la ressource Eventstream synchronise les nouvelles opérations sur les entités organisées.

JSON pour les webhooks

AddressAssignmentsWebhook

{
  "Name": "AddressAssignmentsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
	"Route": "v1/buyers/{buyerID}/addresses/{addressID}/assignments",
	"Verb": "DELETE"
    },
    {
	"Route": "v1/buyers/{buyerID}/addresses/assignments",
	"Verb": "POST"
    }
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

AddressWebhook

{
  "Name": "AddressWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/addresses",
					"Verb": "POST"
				},
				{
					"Route": "v1/buyers/{buyerID}/addresses/{addressID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/addresses/{addressID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/addresses/{addressID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

CatalogsWebhook

{
  "Name": "CatalogsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/catalogs",
					"Verb": "POST"
				},
				{
					"Route": "v1/catalogs/{catalogID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/catalogs/{catalogID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/catalogs/{catalogID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

CategoriesWebhook

{
  "Name": "CategoriesWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/catalogs/{catalogID}/categories",
					"Verb": "POST"
				},
				{
					"Route": "v1/catalogs/{catalogID}/categories/{categoryID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/catalogs/{catalogID}/categories/{categoryID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/catalogs/{catalogID}/categories/{categoryID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

UserGroupAssignmentsWebhook

{
  "Name": "UserGroupAssignmentsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PUT"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}/assignments/{userID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/assignments",
					"Verb": "POST"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

UserGroupsWebhook

{
  "Name": "UserGroupsWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/usergroups",
					"Verb": "POST"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/usergroups/{userGroupID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

UsersWebhook

{
  "Name": "UsersWebhook",
  "ApiClientIDs": ["<API_CLIENT_IDS>"],
  "WebhookRoutes": [
    {
					"Route": "v1/buyers/{buyerID}/users",
					"Verb": "POST"
				},
				{
					"Route": "v1/buyers/{buyerID}/users/{userID}",
					"Verb": "DELETE"
				},
				{
					"Route": "v1/buyers/{buyerID}/users/{userID}",
					"Verb": "PATCH"
				},
				{
					"Route": "v1/buyers/{buyerID}/users/{userID}",
					"Verb": "PUT"
				}
  ],
  "DeliveryConfigID": "<DELIVERY_CONFIG_FROM_EARLIER>"
}

Entités organisées

UserGroups

Catégories

Utilisateurs

UserGroupAssignments

Adresses

AddressAssignment

Catalogues

Important

Pour obtenir un support détaillé, contactez l’équipe Microsoft Cloud for Retail à l’adresse mcfrcommunity@microsoft.com.