Condividi tramite


Configurare Webhook

Importante

Alcune o tutte queste funzionalità sono disponibili come parte di una versione di anteprima. Il contenuto e la funzionalità sono soggetti a modifiche.

I webhook devono essere configurati per sette entità specifiche: UserGroups, Categories, Users,UserGroupAssignments,Addresses,AddressAssignment,Catalogs. Questo articolo illustra i passaggi necessari per configurare e attivare i webhook per il connettore Sitecore OrderCloud.

Passaggio 1: Configurare webhook nel portale OrderCloud

Questo passaggio richiede di specificare l'origine per ogni webhook per garantire una configurazione appropriata.

  1. Vai a Portale OrderCloud > Console API > Configurazioni consegna > Integrazioni POST/deliveryconfig. Immetti il nome WebhooksDeliveryConfig, contrassegna come abilitato.

  2. Scorri verso il basso e trova Hub eventi. Immetti il nome e la stringa di connessione dell'origine Eventstream OrderCloud. Selezionare Invia. Prendi nota dell'ID di configurazione della consegna.

  3. Vai a Webhook, Seleziona l'icona fulmine nell'angolo in alto a sinistra e passa alla visualizzazione classica.

  4. Per ciascuna delle sette entità devi creare un webhook. Per ogni webhook, seleziona l'endpoint webhook POST e immetti il nome.

  5. Sostituisci ogni webhook con il JSON specificato in JSON per webhook.

  6. Immetti l'ID client API e l'ID configurazione consegna corretti.

Passaggio 2. Configurare i webhook nel connettore

Questo passaggio richiede di specificare la destinazione per ogni webhook per garantire una configurazione appropriata.

  1. Vai alla risorsa Webhook Eventstream.

  2. Crea una nuova origine app personalizzata denominata OrderCloud.

  3. Crea una nuova destinazione per ciascuna delle sette entità.

  4. Seleziona lakehouse come nuova destinazione.

  5. Nei campi Nome destinazione e Tabella Delta, immetti il nome dell'entità (Categorie, ad esempio).

  6. Immetti il nome Bronze lakehouse creato e il nome dell'area di lavoro associata.

    Immagine che mostra le impostazioni nei webhook Eventstream.

  7. Ripeti questi passaggi per le altre sei entità.

  8. Dopo aver creato tutte e sette le destinazioni, seleziona Disattiva tutto.

Passaggio 3: Attivare i webhook configurati

Dopo aver configurato l'origine e la destinazione dei webhook, sarà necessario attivarle in modo che i webhook vengano attivati a ogni aggiornamento dei dati. A questo punto, per avviare il flusso di dati devi attivar il webhook. Ad esempio, puoi creare una nuova categoria sul lato origine e osservarne la replica sul lato destinazione.

  1. Torna all'origine Eventstream.

  2. Seleziona l'icona ciclo pertinente per un webhook nella relativa area (Categorie, ad esempio) e organizza i filtri.

  3. Ripeti i passaggi per attivare gli altri sei webhook. Puoi visualizzare le entità organizzate nella sezione Entità organizzate.

  4. Seleziona Attiva tutto. A questo punto la risorsa Eventstream sincronizza le nuove operazioni nelle entità organizzate.

JSON per webhook

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à organizzate

UserGroups

Lo screenshot mostra il webhook Gruppi di utenti.

Categorie

Lo screenshot mostra il webhook Categorie.

Utenti

Lo screenshot mostra il webhook Utenti.

UserGroupAssignments

Lo screenshot mostra il webhook Assegnazione gruppi di utenti.

Indirizzi

Lo screenshot mostra il webhook Indirizzi.

AddressAssignment

Lo screenshot mostra il webhook Assegnazione indirizzo.

Cataloghi

Lo screenshot mostra il webhook Cataloghi.

Importante

Per un supporto personalizzato, contatta il team Microsoft Cloud for Retail all'indirizzo mcfrcommunity@microsoft.com.