Configurar webhooks

Importante

Algumas ou todas estas funcionalidades estão disponíveis como parte de uma versão preliminar. O conteúdo e a funcionalidade estão sujeitos a alterações.

Os webhooks devem ser configurados para sete entidades específicas: UserGroups, Categorias, Usuários, UserGroupAssignments, Endereços, AddressAssignment, Catálogos. Este artigo orienta você nas etapas para configurar e ativar os webhooks para o conector do Sitecore OrderCloud.

Etapa 1. Configurar webhooks no portal do OrderCloud

Essa etapa requer a especificação da origem de cada webhook para garantir a configuração adequada.

1. Acesse Portal do OrderCloud > Console de APIs > Configurações de Entrega > Integrações/deliveryconfig de POST. Preencha o nome como WebhooksDeliveryConfig, marca como habilitado.

2. Role para baixo e encontre o Hub de Eventos. Preencha o nome e a cadeia de conexão da origem do OrderCloud do Eventstream. Seleciona Enviar. Tome nota da ID da Configuração de Entrega.

3. Acesse Webhooks, selecione o raio no canto superior esquerdo e alterne para o modo de exibição Clássico.

4. Para cada uma das sete entidades, você deve criar um webhook. Para cada webhook, Select ponto de extremidade do webhook POST e preencha o nome.

5. Substitua pelo JSON fornecido no JSON para webhooks de cada webhook.

6. Preencha a ID de Cliente da API e a ID de Configuração de Entrega corretas.

Etapa 2. Configurar webhooks no conector

Essa etapa requer a especificação do destino de cada webhook para garantir a configuração adequada.

1. Acesse seu recurso Webhooks do Eventstream.

2. Crie uma origem de Aplicativo Personalizado chamada OrderCloud.

3. Crie um destino para cada uma das sete entidades.

4. Selecione Lakehouse como o novo destino.

5. Nos campos Nome do destino e Tabela Delta, insira o nome da entidade (por exemplo Categorias).

6. Insira o nome do Bronze Lakehouse criado e o nome do espaço de trabalho associado.

   

7. Repita essas etapas para as outras seis entidades.

8. Depois que criar todos os sete destinos, selecione Desativar tudo.

Etapa 3. Ativar os webhooks configurados

Depois que a origem e o destino dos webhooks estiverem configuradas, você deverá ativá-las para que os webhooks sejam desencadeados a cada atualização de dados. Agora, para iniciar o fluxo de dados, você deve desencadear o webhook. Por exemplo, você pode criar uma categoria na origem e observá-la sendo replicada no destino.

1. Volte à origem do Eventstream.

2. Select o ícone de ciclo relevante de um webhook na área dele (por exemplo, Categorias) e organize os filtros.

3. Repita as etapas para desencadear os outros seis webhooks. Você pode ver as entidades organizadas na seção Entidades Organizadas.

4. Selecione Ativar tudo. Agora, o recurso Eventstream sincroniza as novas operações nas entidades organizadas.

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

Entidades Organizadas

UserGroups

Categorias

Usuários

UserGroupAssignments

Endereços

AddressAssignment

Catálogos

Importante

Para obter suporte detalhado, contate a equipe do Microsoft Cloud for Retail em mcfrcommunity@microsoft.com.