Pasos recomendados para crear conectores asistidos REST

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Integrar aplicaciones externas desde Bizagi > Conectores de Bizagi > Crear conectores > Conectores Asistidos REST >

Pasos recomendados para crear conectores asistidos REST

Introducción

Existen dos tipos de conectores: Asistidos REST y Personalizados, como se indica en Crear conectores.

Esta sección presenta una guía de pasos de alto nivel que se deben considerar cuando se desean crear conectores asistidos REST.

 

Antes de comenzar

Es muy importante que primero se tenga conocimiento del API del sistema o aplicación externa a la que desea conectarse.

Ponga especial cuidado al tipo de autenticación que el API de esa aplicación externa soporta.

Esto significa, que usted deberá consultar la documentación oficial de dicho aplicación externo antes de comenzar con el desarrollo de un conector.

 

La información acerca del tipo de autenticación soportada le proporcionará una indicación para determinar si puede crear un conector de tipo Asistido REST, o si por el contrario, es necesario un conector de tipo Personalizado.

Para mayor información sobre cuándo crear un conector Personalizado, consulte los Métodos de autenticación y conectores tipo REST.

 

Pasos para crear conectores Asistidos REST

Al crear un conector de tipo Asistido REST, los siguientes son los pasos generales a considerar:

 

1.Asegúrese de tener una cuenta válida con acceso autorizado a su aplicación externa desde otras aplicaciones (p.e, un nombre de usuario y contraseña válida, además de tokens de acceso u otras configuraciones en su aplicación externa).

2.Utilice el Connector Editor para crear un nuevo conector de tipo REST (opción fácil -Easy-).

 

ConnectorEditor_REST00

 

3.Ingrese los detalles del nuevo conector, incluyendo el tipo de autenticación soportado.

 

REST_3

 

4.Usted puede configurar un base URI para todas las acciones. El Base URI es un parámetro personalizable que puede ser configurado en Bizagi Studio, donde puede personalizar la URL para cada ambiente. Por ejemplo, usted puede definir el Base URI de cada ambiente de la siguiente manera:

Ambiente de desarrollo: https://dev-api.com/services/data

Ambiente de pruebas: https://test-api.com/services/data

Ambiente de producción: https://prod-api.com/services/data

 

Si quiere configurar un Base URI, habilite este campo y escriba el Base URI donde están los servicios que utilizará.

 

REST_11

 

note_pin

Si las acciones del conector se encuentran en URLs diferentes, no utilice esta opción

 

5.Cree al menos una acción y especifique las propiedades de esa acción.

 

REST_1

 

note_pin

En este paso es fundamental que define la URL de servicio (con los parámetros query string que apliquen), el método HTTP de invocación (GET/POST/PUT/DELETE), su codificación (content type), y si la acción utiliza autenticación o no.

 

6.Defina las entradas según sean necesarias para su conector y sean soportadas por el API de su sistema/aplicación externa.

 

REST_7

 

7.Defina las salidas según sean necesarias para su conector y sean soportadas por el API de su sistema/aplicación externa.

 

REST_8

 

note_pin

En este paso usted podrá definir la estructura de los mensajes de error también.

 

8.Descargue el conector.

 

REST_9

 

 

Una vez que tenga el conector como archivo .bizc, siga los pasos de su instalación para probarlo desde Bizagi Studio, como se describe en Instalar y configurar conectores.