Skip to main content

MySQL for Blip Extension

  • Updated

Index:

  1. Introduction

  2. How it Works?

  3. Installation and Configuration

  4. User Manual

  5. Dependencies

  6. Terms of Use

  7. Support

 

Introduction

The MySQL for Blip extension was developed by the company Sharkdev. Currently, it is in version 1.0.0 and available for subscriptions and use.

MySQL for Blip has arrived to make life easier for developers who need to connect to a MySQL database. No more intermediary API! Now you can rely on MySQL for Blip. With this extension, you connect Blip to your MySQL database by providing the connection data, and you're ready to start using it in Builder. It's easy and fast! Let's go!

This manual aims to assist users of the Blip platform in the installation, configuration, and usage of the MySQL for Blip extension.

 

How it Works?

The MySQL for Blip extension was developed with the aim of allowing developers to access databases directly through the builder, without the need for an intermediary API.

The following functionalities are offered:

  • Connection to own database;
  • Execution of SQL statements in the database via HTTP requests;
  • Visualization of SQL statements executed in the database in the last 30 days;

Installation and Configuration

To use the MySQL for Blip extension, you need to access the contract to which you want to install it, and then access the Router bot. Once done, navigate to the extensions section where the Blip Store will open, and search for "MySQL for Blip". Once found, you will need to activate it and install it.

Once activated, installed, and terms accepted, a small configuration is required for you to start using it, follow the step-by-step below:

 

Step 1) Connecting to the database

On the extension's main page, enter name, host, port, user, and password in the connection form and click "Connect".

If the connection is successful, you will quickly see the message "Database connected". If unsuccessful, we suggest reviewing the connection data filled in the form.

 



Step 2) Define token in bot configuration variables

 

For your bot to be able to use the extension, it is necessary that the authorization token be provided at the time of the request.

 

Therefore, we suggest that.

 

 

* This step is not mandatory, but it is a suggestion aiming at maintaining Intelligent Contact.

 

Step 3) Now just use it!

 

At this step, the extension is already configured and you can use it. To do this, familiarize yourself with the concept of commands in the "User Manual".



User Manual

  • SQL Instructions

Follow the instructions below to communicate with the extension via Builder:

Basic Data

Base URL: https://mysqlforblip.blip.sharkdev.com.br/query

Authorization Token: {{config.token}} or Authentication Header (Authorization)

How to execute a command

To execute a command, configure an HTTP Request, using the POST method, to the URL provided in the Base URL, providing the Authorization Token in the "Authorization" key of the Header. For ease, see the image below:

 

 

 

Now, you need to define the Request Body. For this, the JSON sent must follow the attributes below:

 

 

Attribute Typo Mandatory Description
SQL string yes

SQL statement to be executed.

Example:

 

Dependencies

For this extension to function correctly, it is necessary to contract it through the Blip Store, accessing Blip through a paying account. Additionally, the use of your own database is required.

 

 

Terms of Use

  • The database accessed through this application belongs exclusively to the client;
  • The history of database requests will be accessible for 30 days;
  • SharkDev does not claim any ownership rights over the data stored in the client's database;
  • Access data to the database (such as passwords, tokens, or authentication keys) are stored securely in our internal database;
  • The client is responsible for configuring and managing user access levels for the database;
  • The client is solely responsible for the data transmitted, stored, or returned from the database;
  • SharkDev assumes no responsibility for loss, corruption, or misuse of this data;
  • We reserve the right to update or modify these Terms at any time;
  • SharkDev is not responsible for the sharing of authentication keys to Blip when disclosed by the client;
  • All information transmitted will be treated with absolute confidentiality and secrecy, solely within your Blip environment and in accordance with the General Data Protection Law (Law No. 13,709/2018 - LGPD).

Support

If you have any questions or encounter any issues with the extension, please contact us at blippartner@sharkdev.com.br or at +55 (35) 98802-9321.

 

For more information, access the discussion on the topic in our community or the videos on our channel. 😃

Related articles