Konfigurace webhooků

Článek
11/25/2024

Důležité

Některé nebo všechny tyto funkce jsou k dispozici jako součást vydání verze Preview. Obsah a funkce se mohou změnit.

Webhooky je třeba nakonfigurovat pro sedm konkrétních entit: UserGroups, Categories, Users, UserGroupAssignments, Addresses, AddressAssignment, Catalogs. Tento článek vás provede kroky konfigurace a aktivace webhooků pro konektor Sitecore OrderCloud.

Krok 1. Konfigurace webhooků na portálu OrderCloud

Toto krok vyžaduje specifikaci zdroje pro každý webhook, aby bylo zajištěna správné konfigurace.

Přejděte na Portál OrderCloud > Konzole API > Konfigurace doručení > Integrace POST/deliveryconfig. Vyplňte název jako WebhooksDeliveryConfig, označte jako zapnuto.
Přejděte dolů a najděte Centrum událostí. Vyplňte název a připojovací řetězec ze zdroje Eventstream OrderCloud. Vyberte Odeslat. Poznamenejte si ID konfigurace doručení.
Přejděte na webhooky, vyberte blesk v levém horním rohu a přepněte do klasického zobrazení.
Pro každou ze sedmi entit musíte vytvořit každý webhook. Pro každý webhook vyberte koncový bod webhooku POST a vyplňte název.
Nahraďte JSON uvedeným v JSON pro webhooky pro každý webhook.
Vyplňte správné ID klienta API a ID konfigurace doručení.

Krok 2. Konfigurace webhooků na konektoru

Toto krok vyžaduje specifikaci cíle pro každý webhook, aby bylo zajištěna správné konfigurace.

Přejděte do zdroje Webhooks Eventstream.
Vytvořte nový vlastní zdroj aplikace s názvem OrderCloud.
Vytvořte nový cíl pro každou ze sedmi entit.
Vyberte transakční jezero jako nový cíl.
Do polí Název cíle a tabulka Delta zadejte název entity (například kategorie).
Zadejte vytvořený název transakčního jezera Bronze a přidružený název pracovního prostoru.
Opakujte tyto kroky pro dalších šest entit.
Po vytvoření všech sedmi cílů vyberte Deaktivovat vše.

Krok 3. Aktivace nakonfigurovaných webhooků

Po nakonfigurování zdroje a cíle pro webhooky je budete muset aktivovat, aby se webhooky spouštěly při každé aktualizaci dat. Nyní, abyste zahájili tok dat, měli byste spustit webhook. Můžete například vytvořit novou kategorii na zdrojové straně a sledovat, jak se replikuje na cílové straně.

Vraťte se ke zdroji Eventstream.
Vyberte příslušnou ikonu vlny pro webhook v jejich oblasti (například kategorie) a uspořádejte filtry.
Opakováním kroků spustíte dalších šest webhooků. Uspořádané entity si můžete prohlédnout v sekci Uspořádané entity.
Vyberte Aktivovat vše. Nyní prostředek Eventstream synchronizuje nové operace s uspořádanými entitami.

JSON pro webhooky

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