API de Terceros
Nuestro asistente virtual Helper proporciona un área para integrar las APIs externas al chatbot. Con esto, podrá utilizar las API de terceros con todos los recursos de Helper. Esta integración se realiza a través de una solicitud REST y requiere unos pocos pasos para su configuración.
Procedimiento
- Después de acceder a la plataforma, acceda al menú "APIs de terceros";
- La pantalla mostrará las API previamente registradas, si las hay, con las opciones de Edición y Eliminación;
- Si desea buscar una API específica, utilice el campo de búsqueda y haga clic en el botón "Buscar";
- Para registrar una nueva API, haga clic en "Nuevo". Aparecerán los siguientes campos para ser completados:
Campo | Definición |
|---|---|
Nombre | Defina el nombre característico de la API que se registra |
Dependencia | Si es necesario, identifique si la API que se está creando requiere previamente la ejecución de otra API. |
Método | Seleccione el método http que se utilizará en la API: POST, GET, PUT, DELETE o PATCH. |
URL | Defina la URL de la nueva API. Si quiere incluir en la URL un contexto ya registrado en el asistente virtual, ponga el valor entre {}. |
Una vez completados los campos de identificación, vamos a completar los atributos necesarios para dar continuidad a las solicitudes REST: encabezado, cuerpo, respuestas y configuraciones.
Encabezados
Essa função permite adicionar valores necessários para o cabeçalho da requisição REST.
- Haga clic en el botón “+” para añadir el encabezado con la información para:
- lave;
- Valor;
- Haga clic en "Guardar".
Cuerpo
En el cuerpo puede reunir el contenido que se enviará en el cuerpo de la solicitud.
- Haga clic en el botón “+” para añadir el cuerpo con la información de:
2. Haga clic en "Guardar".
Respuestas
En las respuestas, vamos a configurar lo que esperamos de esta API.
- Haga clic en el botón “+” para añadir la información para:
- Formato da respuesta: puede ser en JSON o en texto;
- Nombre;
- Tipo: texto, número, booleano, lista, objeto o contexto;
- Identificaciones.
- Haga clic en "Guardar".
Configuraciones
Aquí definiremos las configuraciones de la solicitud que influirán en la comprensión del asistente
- Seleccione el código deseado para definir los campos:
- Estado htpp de éxito;
- Estado htpp de no autorizado;
- Estado htpp no encontrado.
- *Las opciones presentadas para estos campos están predefinidas por el sistema.
- Luego, define los mensajes que aparecerán en la pantalla del chatbot para los siguientes casos:
- Mensaje de chatbot para contenido no encontrado; Mensaje de chatbot para fallo en la solicitud;;
- Define si la API que se está creando es una API de autenticación.
- Haga clic en "Guardar".