Documentación: Consulta De Integraciones Externas
- Freddy Sanchez Posada (Unlicensed)
Descripción
Esta página está destinada a ayudar a los usuarios administradores a detectar lo que sucede entre los diferentes sistemas que interactúan.
La búsqueda de un log en las integraciones necesita un poco de conocimiento técnico sobre cómo interactúan los sistemas, y también poder leer la información allí almacenada.
Pasos a seguir
Parte de la información se almacena en formato XML, otra en formato JSON, otra en texto plano y otra con una mezcla de todos ellos.
Hay algunos recursos útiles en línea que ayudarán a visualizar los resultados, como
https://jsonformatter.org/ y https://www.freeformatter.com/xml-formatter.html
Para acceder a esta funcionalidad se debe configurar el rol para acceder al acceso al rol EXTERNAL_INTEGRATION y también tener acceso a la página.
Opciones de URL
Customer-search:
Las llamadas desde S4DS a MW Búsqueda de clientes. Para completar la consulta correcta debe incluir en el campo “request” el número de cuenta, nombre o apellido
Customers:
Llamada API para CustomerGet. Estas son las llamadas de S4DS al Middleware para recuperar los datos específicos para un número de cuenta específico.
Debe incluir la cuenta del cliente en el parámetro de request para buscarla.
En el parámetro de response encontrará los detalles del Cliente que se utilizarán para actualizar la información del cliente. En el grupo Préstamo de los metadatos se encuentran las etiquetas importantes para detectar si la cuenta será bloqueada para crear la orden (Códigos de Contracargo, isclosed, isPurged, morosidad, entre otras). Será un campo JSON.
getCreditApplication:
Esta llamada API se produce cuando el MW solicita S4DS para pedidos en un paso específico del flujo de trabajo, para firma electrónica y toma de decisiones de préstamos.
Para buscar aquí es mejor marcar el campo de respuesta con el Número de pedido o cuenta de cliente. En la respuesta estará la carga útil que S4DS envía al MW para procesar el pedido.
Shipping:
Esta API llama desde S4DS al MW y solicita las estimaciones de envío de un pedido.
En el campo de solicitud encontrarás el número de pedido o número de cuenta a buscar y en el campo de respuesta tendrás los costos de envío calculados en el Middleware.
Tax:
Esta API llama desde S4DS al MW y solicita los valores de impuestos y calcula el precio de venta o el precio total de compra de un pedido. Esta llamada ocurre cada vez que el usuario hace clic en el botón “Calcular” en la Pantalla de Total.
En el campo de solicitud encontrarás el número de pedido o número de cuenta a buscar y en el campo de respuesta tendrás los costos de envío calculados en el Middleware.
setCreditStatus:
Esta API es la llamada del MW a S4DS para cambiar el flujo de trabajo de una orden a un estado diferente y/o insertar un mensaje en las “acciones de la orden”.
Para buscar esta carga útil, necesita conocer el código de crécrédito que es el mismo que el ID del ticket, que es visible en el flujo de trabajo del pedido.
La parte importante a verificar aquí está en la solicitud donde el MW establece el estado del pedido y el mensaje.
Verifications:
La API de verificaciones es la llamada de S4DS al Middleware (MW) para comprobar si la orden tiene algún aviso o error. Esta llamada se ejecuta al crear/editar el cliente y cuando se encuentra en el paso HCE_VALIDATION de la orden.
Para buscar aquí, debe buscar en el campo de solicitud, buscar el número de pedido o el número de cuenta del cliente y leer el campo "respuesta" para obtener la respuesta de validación de MW.
getPhoneInfo_V2
Esta es una llamada de validación de S4DS al MW que verifica si el número de teléfono es válido.
El parámetro aquí es el número de teléfono y está en la URL.
Para especificar la búsqueda, puede utilizar esta cadena para buscar una respuesta para un teléfono específico
Número de teléfono=2678912687
En el campo de respuesta habrá un campo JSON que contiene si el teléfono es una línea móvil. De lo contrario, esta validación fallará.
callRestWebService:
Esta API es donde se llaman los WebHooks desde S4DS al MW, informando que ha ocurrido algún evento en S4DS.
Ejemplos de llamadas WebHook son
NewMessage: se insertó un nuevo mensaje en el pedido en S4DS
NewDocument: Distribuidor u OMS cargó un nuevo documento en S4DS
creditDecision: Hay órdenes pendientes (al menos una) en decisión de crédito para que el MW pueda llevar a TKL
resentCreditDecision: Hay órdenes pendientes (al menos una) después de un flujo posterior al rechazo para que el MW pueda llevarlas de regreso a TKL.
Firma: Hay pedidos listos para iniciar el proceso de firma.
Reenviar firma: el usuario hizo clic en reenviar firma electrónica y el MW debe tomar esas órdenes para firmar nuevamente.
Esto es útil para comprobar si el Middleware fue informado sobre algún evento o acción específica.
getOffSyncOrders:
Esta llamada API es del MW a S4DS solicitando un pedido específico o un grupo de pedidos que están en estado facturado.
Estos son los datos finales del pedido en S4DS porque nadie en el estado facturado no puede editar el pedido.
Para buscar esto en el campo de respuesta, puede utilizar el número de pedido o el número de cuenta, o cualquier otro dato importante como nombre, dirección, etc., para buscar.
getOffSyncEntities:
Esta llamada API es de MW a S4DS para recuperar la información de una persona (cliente, cofirmante o distribuidor).
Para buscar hay que mirar en el campo de solicitud el número de cuenta o código de distribuidor (ID del documento para ambos) y ver el campo de respuesta que tendrá todos los datos de esa persona en particular.
SetNewCustomer:
Esta llamada API es del MW a S4DS y tiene como objetivo crear o modificar cualquier campo de cliente.
En el campo “solicitud” encontrarás los datos que se actualizarán en S4DS.
El campo de respuesta indica si la inserción/actualización fue exitosa o no. Revisa el mensaje.
Artículos Relacionados