Solicitudes de API externas
Comuníquese con cualquier API e integre cualquier servicio.
Las solicitudes de API externas le permiten definir plantillas de solicitud y, a continuación, desencadenar llamadas salientes a cualquier API desde los procesos empresariales. Con ellas, puede conectar su proyecto a cualquier servicio de terceros, incluso si aún no existe ningún módulo para ello en el mercado.
Definición
Consulte las especificaciones de cómo debe estructurarse la solicitud en la documentación de la API del proveedor de servicios con el que desea conectarse.
- Para definir una nueva plantilla de solicitud, vaya a la pestaña "Lógica empresarial" de la barra lateral (1), cambie a la pestaña "Solicitudes de API externas" (2) y haga clic en "Nueva solicitud de API" (3).
3. Seleccione el método HTTP de la solicitud y su URL.
4. Defina los parámetros de la URL, los parámetros de consulta (sólo para solicitudes GET), las cabeceras y el cuerpo de la solicitud introduciendo el nombre del parámetro (1), su tipo (2) y haciendo clic en "Añadir parámetro" (3).
El valor real de estos parámetros se definirá en el momento de la ejecución del proceso de negocio, donde se desencadena la solicitud.
Para entender la diferencia entre parámetros de URL y de consulta, lea más aquí. Sin embargo, independientemente de los estándares, la documentación de la API del proveedor de servicios con el que desea conectarse es la mejor fuente de información sobre cómo construir la solicitud.
También puede autocompletar las cabeceras y el cuerpo de la solicitud introduciendo un ejemplo de JSON, el sistema creará todos los parámetros necesarios automáticamente.
No tiene que añadir nuevos parámetros en cada solicitud. Algunas solicitudes pueden no contener ningún parámetro de URL, cabecera o cuerpo, por ejemplo.
En caso de que su solicitud contenga objetos (por ejemplo, coche -> color, tamaño, etc.), tendrá que crear modelos virtuales para procesar estos objetos posteriormente en sus procesos de negocio. Hágalo seleccionando "Modelo" en el selector de tipo de parámetro, e introduciendo los elementos hijos que necesite. Puede anidar los objetos tantas veces como necesite (es decir, objeto dentro de objeto) y crear matrices de modelos virtuales. En el caso de que hayas utilizado el autorelleno, este proceso se completará automáticamente.
5. Cambie la configuración de la solicitud, como la verificación SSL, el tiempo de espera y la gestión de errores en la pestaña "Configuración".
7. 7. Guarde la plantilla de solicitud haciendo clic en "Guardar solicitud".
Utilice
Después de definir y guardar una nueva solicitud, un nuevo bloque estará disponible en el Editor de Procesos de Negocio para activarla.
Tendrá que proporcionarle todos los componentes que desee añadir a la petición (URL y parámetros de consulta, cabeceras y el cuerpo) como modelos de datos, que pueden realizarse mediante estos bloques. En la salida, podrá extraer el cuerpo formateado de la respuesta, sus cabeceras y el estado de la respuesta. Puede ampliar estos modelos utilizando estos bloques.
No es necesario conectar todas las entradas de datos para que la solicitud se active correctamente. Por ejemplo, si tiene una solicitud sin parámetros de URL, no tiene que crear su modelo y conectarlo.
Por cada modelo virtual que haya definido, se añadirán 2 nuevos bloques a su Editor de Procesos de Negocio para realizarlo y ampliarlo.
Monitorización
Cada vez que se activa una solicitud de API, el sistema enviará a los registros su tipo y dirección, el cuerpo de la solicitud, el código de estado HTTP de la respuesta y el cuerpo de la respuesta. Puede enviar otra información, como campos específicos del cuerpo de la respuesta, o la latencia a los registros utilizando el bloque Escribir en el registro.
