El propósito de este documento es proporcionar una guía para el uso correcto del servicio API de Hub Transaccional, a continuación puede ver ejemplos del cuerpo de la solicitud para iniciar flujos.
Endpoint generado para recibir solicitudes de nuevos flujos creados en el Hub Transaccional.
| Método HTTP | Endpoint |
|---|---|
| POST | https://hub-transaccional.masivapp.com/api/hub-transaccional-model/flow/init-from-api |
Estructura de solicitud de nuevos flujos creados desde la interfaz gráfica de Masiv Web. (https://masivapp.com/)
| Header | Tipo | Descripción |
|---|---|---|
| Authorization | string | Basic 64 autenticación token codificado en base 64 siguiendo esta estructura: username:password |
| Body | Tipo | Descripción |
|---|---|---|
| dataToReplace | array | Colección de personas en un array, que entrará en el flujo. |
| flowId | string | Id que representa el flujo creado desde la interfaz web |
Ejemplo de respuesta exitosa:
| Responses | Descripción |
|---|---|
| 🟢 200 | Solicitud recibida con éxito |
{
"status": "ok",
"pTracking": "5fe25b29c33b9800109bb854"
}
Respuesta no exitosa:
| Responses | Descripción |
|---|---|
| 🔴 500 | El ID del modelo no coincide con el creado para la cuenta autentificada |
Ejemplo:
{
"status": "error",
"response": "FLOW-SERVICE originalError:(model not found)"
}
NOTA: Hay que tener en cuenta que los objetos dentro del parámetro dataToReplace corresponden a los parámetros configurados desde la interfaz web para iniciar un flujo transaccional.