Saltar al contenido principal

Extensión MongoDB para Blip.

  • Actualización

Índice:

  1. Introducción
  2. ¿Cómo funciona?
  3. Instalación y configuración
  4. Manual de uso
  5. Dependencias
  6. Términos de uso
  7. Soporte 



Introducción

La extensión MongoDB for Blip fue desarrollada por la empresa Sharkdev. Actualmente, se encuentra en la versión 1.0.0 y está disponible para suscripciones y uso.

MongoDB for Blip ha llegado para facilitar la vida del desarrollador que necesita conectarse a una base de datos Mongo. ¡Nada de API intermedia! Ahora puedes contar con MongoDB for Blip.  Con esta extensión, conectas Blip a tu base de datos MongoDB proporcionando los datos de conexión y ya puedes comenzar a usarlo en el Builder. ¡Es fácil y rápido! ¡Vamos allá!

Este manual tiene como objetivo ayudar a los usuarios de la plataforma Blip con la instalación, configuración y uso de la extensión MongoDB for Blip.

 

¿Cómo funciona?

La extensión MongoDB for Blip fue desarrollada con el objetivo de permitir a los desarrolladores acceder a bases de datos directamente desde el builder, sin la necesidad de una API intermedia.
Se ofrecen las siguientes funcionalidades:

 

  • Conexión con base de datos propia;
  • Ejecución de comandos en la base de datos por solicitudes HTTP;
  • Visualización de comandos ejecutados en la base de datos en los últimos 30 días;

 

Instalación y configuración

Para utilizar la extensión MongoDB for Blip, es necesario acceder al contrato donde desea instalarla, y después ingresar al bot Router. Una vez hecho esto, navegue hasta la parte de extensiones donde se abrirá la Blip Store, y busque por “MongoDB for Blip”. Cuando lo encuentres, será necesario activarlo e instalarlo.

Después de activado, instalado y aceptados los términos, es necesario una pequeña configuración para que puedas comenzar a usarlo, sigue los siguientes pasos.

 

Paso 1) Conectando a la base de datos

En la página principal de la extensión, informe nombre, anfitrión, usuario y contraseña en el formulario de conexión y haga clic en "Conectar".

 

Si la conexión se realiza con éxito, rápidamente verá el mensaje "Base de datos conectada". Si no tienes éxito, te sugerimos que revises los datos de conexión que ingresaste en el formulario.

 

 

Paso 2) Definir token en las variables de configuración de los bots

Para que su bot pueda utilizar la extensión, es necesario que el token de autorización se proporcione en el momento de la solicitud.

 

 

* Este paso no es obligatorio, pero es una sugerencia para mantener el Contacto Inteligente.

 

Paso 3) ¡Ahora solo úsalo!

En este paso, la extensión está configurada y ya puedes usarla. Para ello, conoce el concepto de comandos en el “Manual de uso”.

 

Manual de uso

Comandos

Al igual que Blip, la forma de comunicarse con la extensión a través de Builder es mediante comandos. Para ello, siga las siguientes instrucciones:

Datos básicos

URL base: https://mongoforblip.blip.sharkdev.com.br/commands

Token de autorización: {{config.token}} o Encabezado de autenticación (Authorization)

Cómo ejecutar comando

Para ejecutar un comando, configure una Solicitud HTTP, utilizando el método POST, para la URL proporcionada en URL base, proporcionando el Token de autorización en la clave "Authorization" del encabezado. Para facilitar, vea la imagen a continuación:

 



Ahora, necesitas definir el cuerpo de la solicitud. Para ello, el JSON enviado debe seguir los atributos a continuación:



Atributo Tipo Obligatorio Descripción
collection string Sí Nombre de la colección en la cual se ejecutará el comando.

Ejemplo: notas
command object Sí Lista de métodos a ejecutar, basada en métodos de Collection y Cursor del propio MongoDB.

Ejemplo: {
   find: {
     group: 'example'
   },
   sort: 'name'
}
apply boolean No

Hace que métodos del tipo array se pasen como parámetros del método a procesar.


Default: false

 

A continuación, enumeramos algunos ejemplos del Body de una solicitud.

 

Cómo insertar un documento
Cómo buscar un documento específico
Cómo listar documentos
Cómo actualizar un documento
Cómo eliminar un documento
Cómo ordenar el listado de documentos
Cómo utilizar ObjectId

Cómo ejecutar un aggregate

 

Dependencias

Para que esta extensión funcione correctamente, es necesario contratarla a través de la Blip Store accediendo a Blip mediante una cuenta pagadora. Además, se requiere el uso de una base de datos propia.

 

Términos de uso

  • La base de datos accedida a través de esta aplicación pertenece exclusivamente al cliente;
  • El historial de solicitudes a la base de datos estará disponible durante 30 días;
  • SharkDev no reclama ningún derecho de propiedad sobre los datos almacenados en la base de datos del cliente;
  • Los datos de acceso a la base de datos (como contraseñas, tokens o claves de autenticación) se almacenan de manera segura en nuestra base de datos interna;
  • El cliente es responsable de configurar y administrar los niveles de acceso de los usuarios de la base de datos;
  • El cliente es el único responsable de los datos transmitidos, almacenados o recuperados de la base de datos;
  • SharkDev no asume ninguna responsabilidad por pérdida, corrupción o uso indebido de estos datos;
  • Nos reservamos el derecho de actualizar o modificar estos Términos en cualquier momento;
  • SharkDev no se hace responsable de compartir claves de autenticación con Blip cuando son divulgadas por el cliente;
  • Toda la información transmitida será tratada con absoluta confidencialidad y secreto, únicamente dentro de su entorno Blip y de acuerdo con la Ley General de Protección de Datos Personales (Ley nº 13.709/2018 - LGPD).

 

Soporte

En caso de dudas o si encuentra algún problema con la extensión, contáctenos por correo electrónico blippartner@sharkdev.com.br o al número +55 (35) 98802-9321.

 

Para obtener más información, acceda a la discusión sobre el tema en nuestra comunidad o los vídeos en nuestro canal. 😃

Artículos relacionados