Índice:
Conozca qué es una solicitud HTTP, situaciones en las que podemos usar una solicitud HTTP y cómo realizar una solicitud HTTP en Builder para obtener datos de usuario de su código postal o CPF, así como una solicitud de comercio electrónico a partir del código de solicitud.
Vídeo de orientación
¿Qué es una solicitud HTTP?
Cuando se accede a un sitio web, el navegador (Google, Edge, Opera, etc.) envía una solicitud HTTP al servidor, solicitando información específica. El servidor busca en sus archivos lo solicitado, y cuando lo encuentra envía lo encontrado como respuesta que es interpretada por el navegador, mostrándola en forma de página web en una pantalla.
Técnicamente, HTTP es un protocolo basado en flujos de texto. Es un protocolo para la comunicación y transferencia de páginas HTML. Brevemente, el cliente envía solicitudes (requests) y recibe respuestas del servidor (responses), como se representa en la siguiente figura.
El protocolo HTTP define un conjunto de métodos de solicitud encargados de indicar la acción a realizar para un determinado recurso. Métodos de ejemplo: GET, POST, PUT, DELETE, PATCH
Usaremos los métodos GET y POST como ejemplo para realizar una solicitud HTTP dentro de Blip y para eso necesitamos completar algunos campos indicando lo que queremos en nuestra solicitud.
Método GET: se recomiendan solicitudes GET para obtener datos de un recurso determinado.
Método POST: las solicitudes POST se utilizan con mayor frecuencia para enviar información para ser procesada, como la creación de algún recurso, como un producto o un cliente.
Situaciones en las que podemos usar una solicitud HTTP en Builder
- Obtenga la dirección completa de un usuario a partir de su código postal;
- Obtener datos como el nombre, la dirección o la afiliación de un usuario de su CPF;
- Obtener datos de un pedido de comercio electrónico a partir del código de pedido;
Nota: si la API utilizada es pública, no se requiere ningún método de autenticación.
¿Cómo hacer una solicitud HTTP en Builder?
Aquí hay un ejemplo paso a paso de cómo hacer solicitudes HTTP a través de Builder. En este ejemplo, el objetivo es obtener los datos de la dirección de un usuario a partir del código postal tecleado. Para ello utilizaremos la API pública de la oficina de correos.
1) El primer paso es CREAR SU FLUJO DE CHATBOT e IDENTIFICAR EN QUÉ BLOQUE EL USUARIO INGRESARÁ LA INFORMACIÓN que se obtendrá de la API.
2) En este bloque HAGA CLIC EN EL MENSAJE EN EL QUE EL USUARIO INGRESARÁ LA INFORMACIÓN QUE SERÁ ALMACENADA y posteriormente buscada en la API.
3) Después de hacer clic en el mensaje, haga clic en “GUARDAR RESPUESTA EN VARIABLE” y escriba un nombre de interés en el campo “VARIÁVEL” (en este caso el código postal). Así, la información ingresada por el usuario quedará guardada y podrá utilizar esta variable posteriormente.
4) Luego, accede a la opción “ACCIONES” en el menú superior de este mismo bloque.
5) Desde allí desliza la barra y en “ACCIONES DE SALIDA” haz clic en: “AÑADIR CONDICIONES DE SALIDA”, selecciona: “SOLICITUD HTTP”.
6) Luego de seleccionar el tipo de método (GET o POST) se debe INTRODUCIR LA URL DE LA API donde se solicitará la solicitud y se almacenará el NOMBRE DE LA VARIABLE (creada en el paso 2) INTRODUCIR CLAVES para realizar la búsqueda según lo el usuario escribió.
7) Después de eso, en el bloque donde tendremos la respuesta del bot de acuerdo con la respuesta de la solicitud HTTP, haga clic en “ACCIONES” → AGREGAR ACCIÓN DE ENTRADA → EJECUTAR SCRIPT
8) En la parte del script, cree una función que recibirá la variable de entrada. Dentro de la función, cree una variable que recibirá "JSON.parse(input)" y luego devolverá la propiedad deseada.
Guarde la variable de respuesta en el campo “ENTRADA VARIABLES”, como en el ejemplo de abajo con: “corpocep”, para que sea devuelta en el chat. Las variables de entrada se reciben como parámetros en la función de JavaScript.
9) Las variables creadas se usan entre llaves en el bloque bot y se reemplazan por los valores encontrados después de la solicitud.
10) ¡Listo! Ahora, en la vista del usuario, al usar el chatbot, los mensajes se muestran como se muestra a continuación:
11) Si necesita cambiar algo en el script, haga clic en "EJECUTAR SCRIPT" y acceda al script guardado. ¡Ya puedes probar tu chatbot!
Ejemplo de solicitud HTTP con autenticación
A continuación, ejemplificaremos cómo realizar una solicitud HTTP que contenga la autenticación BLIP. En este ejemplo, queremos obtener los correos electrónicos de todos los usuarios que dieron su correo electrónico al chatbot.
Por ejemplo, supongamos que 10 personas usaron el chatbot y proporcionaron su propio correo electrónico. A través de esta solicitud HTTP, obtenemos los 10 correos electrónicos escritos por estas personas. Esta solicitud también se puede utilizar para obtener el número de teléfono, CPF, nombre y otros datos ingresados por el usuario.
- El primer paso es crear un bloque donde se solicitará la información deseada. En nuestro ejemplo, solicitamos el correo electrónico del usuario en el bloque "Boas Vindas".
- En el texto ingresado por el usuario, haga clic en el texto y habilite la opción: “GUARDAR RESPUESTA EN VARIABLE”, luego escriba un nombre para esta variable. De esta forma, está almacenando la respuesta tecleada por el usuario, para no perder estos datos.
- Cree un nuevo bloque, en este bloque se ejecutará la solicitud HTTP. En nuestro ejemplo, este bloque es el bloque "Buscando contactos".
- Accede a la pestaña “ACCIONES”, haz clic en “AÑADIR ACCIÓN DE ENTRADA” y selecciona “SOLICITUD HTTP”.
- Acceda a la solicitud que se utilizará en BLIP Docs y verifique si el método es POST o GET. Por lo tanto, complete el tipo de método en el primer campo del Generador. Luego, copie la URL junto al tipo de método, en nuestro ejemplo, la URL es: https://{{contract_id}}.http.msging.net/commands y péguela en el segundo campo del Biuder, siguiendo las imágenes a continuación.
- Luego haga clic en el icono de configuración en la parte superior derecha de la pantalla:
- Accede a “INFORMACIÓN DE CONEXIÓN” en el menú lateral izquierdo:
- Desplácese hacia abajo en la página y busque "PUNTOS FINALES HTTP", copie el primer campo "ENCABEZADO DE AUTENTICACIÓN (AUTORIZACIÓN)".
- Regrese al bloque donde creó la Acción de solicitud HTTP, en la pestaña ACCIONES → “SOLICITUD HTTP”, acceda a “ENCABEZADOS” y escriba “AUTORIZACIÓN” en el campo “CLAVE” y pegue el texto copiado anteriormente en el “VALOR” campo.
10) Regrese a BLIP Docs y copie el "BODY" de la solicitud:
{
"id": "{{$guid}}",
"to": "postmaster@crm.msging.net",
"method": "get",
"uri": "/contacts?$skip=0&$take=3"
}
11) Dentro de la solicitud HTTP, acceda a "BODY" y pegue el código copiado.
12) Debajo de “CUERPO”, vaya a “GUARDAR RESPUESTA” y rellene los campos con el nombre que prefiera para almacenar las respuestas obtenidas.
13) Cree un nuevo Bloque, donde se mostrará la devolución de la solicitud. Crea un texto con la variable “RETORNO” creada en el paso anterior.
- Asegúrese de que el nombre de la variable sea el mismo que creó y que la variable esté encerrada entre dos llaves.
14) Haga clic en el ICONO ROCKET para publicar el fluxo y luego en el icono del bot de prueba:
15) Al probar el bot, tan pronto como el usuario ingresa el correo electrónico, la variable {{return}} devolverá todos los correos electrónicos de los contactos, es decir, de esta manera es posible obtener los correos electrónicos ingresados por los usuarios en el chatbot. a través de una solicitud HTTP!
Para obtener más información, acceda a la discusión sobre el tema en nuestra comunidad o los videos en nuestro canal. 😃