Este componente permite hacer el consumo de APIs mediante REST dentro de los flujos de wolkvox Studio.
Se encuentra dentro del grupo de componentes llamado “Comunicaciones” y está disponible en todos los tipos de routing (Voice, Interaction, Chat y CRM + webhook) y Agent Scripting.
Rest API es una forma de conectar aplicaciones entre sí con el fin de que puedan compartir información y realizar tareas.
Este se basa en el protocolo HTTP para permitir que los sistemas interactúen entre sí de manera eficiente escalable.
REST API posee varios métodos disponibles para realizar diferentes tareas como actualizar información, eliminar elementos, obtener datos, etc.
El componente permite consumir APIs mediante los métodos GET, POST, PUT Y DELETE.
- Método PUT: Es utilizado para actualizar información de un recurso existente en el servidor. Una vez hecha la solicitud por método PUT, se sobrescribe el recurso existente con la nueva información enviada en la solicitud.
- Método POST: Es utilizado para enviar información al servidor. Por ejemplo, puede usarse para enviar archivos o datos de formularios.
- Método GET: Es utilizado para obtener información acerca de un recurso. Una vez consultada la solicitud, se devuelve la respuesta con la información solicitada.
- Método DELETE: Es utilizado para eliminar un recurso en el servidor. Por ejemplo, dentro de las APIs de wolkvox existe una para eliminar agentes.
Este componente permite escribir el formato del body (cuerpo) en dos formas: “form-data” y “raw”.
- form-data: Se utiliza principalmente para enviar datos de formulario. Este envía el cuerpo de la solicitud en formato de texto plano. Inclusive permite incluir archivos adjuntos.
- raw: Se utiliza principalmente para enviar datos en un formato específico, como JSON, XML o texto plano. La elección del formato del cuerpo dependerá del tipo de dato enviado en la solicitud.
Control timeout: Se espera que en máximo 60 segundos se obtenga respuesta del API; superado ese tiempo sin haber logrado en consumo de la API, este componente devuelve un mensaje de error llamado “Error consuming www.apidelcliente.com”.
Si deseas ir a la documentación de APIs da clic aquí.
Límite de longitud del token de autorización en el componente REST API #
En el componente REST API de wolkvox Studio, es crucial que el token de autorización no exceda los 257 caracteres. Si el token sobrepasa este límite, existe el riesgo de que se corte y la autorización no funcione correctamente, lo que generaría un error en la respuesta del API.
Solución recomendada: Si el token tiene más de 257 caracteres y no es posible reducir su longitud, se debe asignar el token como una variable en wolkvox Studio. A continuación, un ejemplo de cómo hacerlo:
Authorization:’.$token
En este caso, el valor de la variable debe ser calculado previamente con el componente de “Computo de Variables” de wolkvox Studio.
Esta solución permite manejar tokens largos y evitar problemas de autorización en las consultas API, garantizando el correcto funcionamiento del componente.
#
Ejemplo de uso #
Para este caso de ejemplo, se va a usar la API que permite deshabilitar o desactivar un agente. En la siguiente captura de pantalla se evidencia que antes de hacer la prueba, el agente se encuentra habilitado.
Primero, se debe llenar los campos de configuración de la API según la documentación, se crea una variable para almacenar el resultado y por último da clic en el botón “Guardar”.
Podrás configurar un tiempo de espera para obtener la respuesta del consumo de una API. Por ejemplo, si requieres de un tiempo específico para que la API termine de consumirse, podrás configurar el tiempo en el nuevo campo. Esto es útil en los casos donde el consumo de una API sea demorado por cuestiones de volumen de la data o múltiples motivos.
- Puedes definir un tiempo máximo de espera de 300 segundos o 5 minutos.
- Gracias a esta novedad obtienes flexibilidad y control adicional para gestionar tus consumos de API por medio del componente “Rest API” en wolkvox Studio.
- Nota: En su campo se debe de colocar el valor en segundos.
Luego, se salta a la pestaña “Prueba”, en donde debes dar clic en “Probar” para iniciar el consumo de la API. Al instante saltará el resultado de la prueba.
Para este caso se consumió la API de manera exitosa, deshabilitando así un agente de la operación.
A continuación se muestra que el agente ha sido deshabilitado.
