Configurar webhooks

Importante

Algunas o todas estas funciones están disponibles como parte de una versión preliminar. El contenido y la funcionalidad están sujetos a cambios.

Los webhooks deben configurarse para siete entidades específicas: UserGroups, Categories, Users,UserGroupAssignments,Addresses,AddressAssignment,Catalogs. Este artículo lo guía a través de los pasos para configurar y activar los webhooks para el conector Sitecore OrderCloud.

Paso 1. Configurar webhooks en el portal OrderCloud

Este paso requiere especificar la fuente de cada webhook para garantizar que estén configurados correctamente.

1. Vaya a Portal de OrderCloud > Consola API > Configuraciones de entrega > Integraciones POST/deliveryconfig. Complete el nombre como WebhooksDeliveryConfig, marca habilitada.

2. Desplácese hacia abajo y encuentre Centro de eventos. Complete el nombre y la cadena de conexión de la fuente Eventstream OrderCloud. Seleccione Enviar. Anote el ID de configuración de entrega.

3. Vaya a Webhooks, seleccione el rayo en la esquina superior izquierda y cambie a la vista clásica.

4. Para cada una de las siete entidades, debe crear un webhook. Para cada webhook, seleccione POST punto final del webhook y completw el nombre.

5. Reemplazar con el JSON proporcionado en el JSON para webhooks para cada webhook.

6. Complete el ID de cliente de API y el ID de configuración de entrega correctos.

Paso 2. Configure webhooks en el conector

Este paso requiere especificar el destino de cada webhook para garantizar que estén configurados correctamente.

1. Vaya a su recurso Webhooks Eventstream.

2. Cree una nueva fuente de aplicación personalizada llamada OrderCloud.

3. Cree un destino nuevo para cada una de las siete entidades.

4. Seleccione Almacén de lago como nuevo destino.

5. En los campos Nombre de destino y Tabla Delta, ingrese el nombre de la entidad (Categorías, como ejemplo).

6. Introduzca el nombre almacén de lago bronce creado y el nombre del espacio de trabajo asociado.

   

7. Repita estos pasos para las otras seis entidades.

8. Tras crear los siete destinos, seleccione Desactivar todo.

Paso 3. Activar los Webhooks configurados

Una vez configurados el origen y el destino de los webhooks, deberá activarlos para que se activen con cada actualización de datos. Ahora, para iniciar el flujo de datos, debe activar el webhook. Por ejemplo, puede crear una nueva categoría en el lado de origen y observar cómo se replica en el lado de destino.

1. Vuelva al origen de Eventstream.

2. Seleccione el icono de lanzamiento relevante para un webhook en su área (Categorías, por ejemplo) y organice filtros.

3. Repita los pasos para desencadenar los otros seis webhooks. Puedes ver las entidades ordenadas en la sección Entidades organizadas.

4. Seleccione Activar todo. Ahora el recurso Eventstream sincroniza las nuevas operaciones en las 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

Categorías

Usuarios

UserGroupAssignments

Direcciones

AddressAssignment

Catálogos

Importante

Para soporte detallado, contacte con el equipo de Microsoft Cloud for Retail en mcfrcommunity@microsoft.com.