Webhooks configureren

Belangrijk

Een gedeelte van of alle functionaliteit is beschikbaar als onderdeel van een preview-release. De inhoud en functionaliteit zijn aan verandering onderhevig.

Webhooks moeten worden geconfigureerd voor zeven specifieke entiteiten: UserGroups, Categories, Users,UserGroupAssignments,Addresses,AddressAssignment,Catalogs. In dit artikel worden de stappen voor het configureren en activeren van webhooks voor de Sitecore OrderCloud-connector beschreven.

Stap 1. Webhooks configureren op de OrderCloud-portal

In deze stap moet u de bron voor elke webhook opgeven om een ​​juiste configuratie te kunnen garanderen.

1. Ga naar OrderCloud-portal > API-console > Leveringsconfiguraties > POST-integraties/deliveryconfig. Vul de naam in als WebhooksDeliveryConfig en markeer deze als ingeschakeld.

2. Scroll naar beneden en zoek naar Event Hub. Vul de naam en connection string in uit de Eventstream OrderCloud-bron. Selecteer Verzenden. Let op de leveringsconfiguratie-id.

3. Ga naar Webhooks, selecteer de bliksemschicht in de linkerbovenhoek en schakel over naar de klassieke weergave.

4. Voor elk van de zeven entiteiten moet u een webhook maken. Selecteer voor elke webhook het POST-webhook-eindpunt en vul de naam in.

5. Vervang dit door de JSON die is opgegeven in de JSON voor webhooks voor elke webhook.

6. Vul de juiste API Client ID en Delivery Config ID in.

Stap 2. Webhooks configureren op de connector

In deze stap moet u de bestemming voor elke webhook opgeven om een ​​juiste configuratie te kunnen garanderen.

1. Ga naar uw Webhooks Eventstream-resource.

2. Maak een nieuwe bron voor een aangepaste app met de naam OrderCloud.

3. Maak een nieuwe bestemming voor elk van de zeven entiteiten.

4. Selecteer Lakehouse als nieuwe bestemming.

5. Voer in de velden Bestemmingsnaam en Deltatabel de naam van de entiteit in (bijvoorbeeld Categorieën).

6. Voer de aangemaakte Bronze Lakehouse-naam en de bijbehorende werkruimtenaam in.

   

7. Herhaal deze stappen voor de andere zes entiteiten.

8. Nadat u alle zeven bestemmingen hebt gemaakt, selecteert u Alles deactiveren.

Stap 3. De geconfigureerde webhooks activeren

Nadat de bron en bestemming voor de webhooks zijn geconfigureerd, moet u deze activeren, zodat de webhooks bij elke gegevensupdate worden geactiveerd. Trigger de webhook om de gegevensstroom te starten. U kunt bijvoorbeeld een nieuwe categorie aan de bronzijde maken en observeren hoe deze aan de bestemmingszijde wordt gerepliceerd.

1. Terug naar Eventstream-bron.

2. Selecteer het relevante wave-pictogram voor een webhook in hun gebied (bijvoorbeeld Categorieën) en rangschik de filters.

3. Herhaal de stappen om de andere zes webhooks te activeren. De gerangschikte entiteiten kunt u zien in de sectie Gerangschikte entiteiten.

4. Selecteer Alles activeren. Nu synchroniseert de Eventstream-resource de nieuwe bewerkingen met gerangschikte entiteiten.

JSON voor 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>"
}

Gerangschikte entiteiten

UserGroups

Categorieën

Gebruikers

UserGroupAssignments

Adressen

AddressAssignment

Catalogi

Belangrijk

Neem voor gedetailleerde ondersteuning via mcfrcommunity@microsoft.com contact op met het team van Microsoft Cloud for Retail.