As requisições são realizadas com o método POST na URL, ou seja, https://chatter.mavibot.ai/api/{api\\_key}/{action}

Onde está localizado: api_key é a chave de acesso à API, obtida nas configurações do projeto:

Você pode obter a chave de acesso usando a variável #{api_key}. Ela contém a chave gerada relevante. Não se esqueça de gerar uma antes de usá-la.

Ao copiar a URL da consulta desta página, um espaço é inserido e precisa ser excluído ao chamar

Um exemplo de cópia do link de forma errada: https://chatter.mavibot.ai/api/callback 

O espaço após .pro é fácil de não notar, mas se for mantido, a consulta não funcionará

Ao enviar a requisição com o método GET, não use palavras proibidas. Verifique a formação correta de requisições GET

Como receber mensagens na URL do Webhook especificada nas configurações do projeto

As configurações do projeto

Cada mensagem recebida ou enviada chega com as seguintes requisições json POST:

{
    'id': o identificador da mensagem no sistema,
    'client': {
        'id': o identificador do cliente no sistema,
        'recepient': o identificador do cliente no mensageiro,
        'client_type': o tipo do mensageiro,
        'name': o nome do cliente,
        'avatar': o avatar do cliente,
        'created_at': a data em que o cliente foi criado,
        'tag': a chave de inscrição,
        'group': o bot ao qual o cliente está vinculado,
    },
    'message': o texto da mensagem,
    'attachments': a matriz de links para arquivos,
    'message_id': o id do bloco do qual a mensagem foi enviada,
    'project_id': o id do projeto,
    'is_input': 1 se a mensagem é de um cliente, 0 se é do bot,
    'delivered': 1 se a mensagem foi enviada com sucesso, 0 se houve um erro,,
    'error_message': a mensagem explicando o erro
}

Se a requisição retornou com um erro, ela não será reenviada. Se o servidor retornou com um erro, as notificações continuarão chegando apesar disso.

Como usar um webhook universal

Esses métodos agora podem ser iniciados tanto com a requisição POST quanto com a GET.

Anteriormente, os parâmetros (com os quais os métodos dos clientes eram iniciados, ou seja, client_id) eram escritos de forma muito rígida em nossos métodos, o que impunha algumas restrições ao usá-los com serviços de terceiros.

Agora você pode indicar em qual parâmetro da requisição o Mavibot procurará o identificador do usuário: para isso, é usado um parâmetro com o prefixo value_, como value_user_id e value_group_id.

Além disso, o método para enviar o callback callback pode ser iniciado transmitindo um e-mail (client_email) e um número de telefone do cliente (client_phone).

Os métodos callback e whatsapp_callback não estão vinculados aos nomes dos parâmetros. Você pode especificar qual parâmetro conterá o número de telefone, e-mail e id do cliente.

Isso é útil ao configurar o recebimento do webhook através de outro site.

Para especificar qual variável contém client_id você precisa transferir value_client_id e mencionar o nome do parâmetro com esse valor

Para especificar qual variável contém o telefone você precisa transferir value_phone e mencionar o nome do parâmetro com esse valor

Para especificar qual variável contém o e-mail você precisa transferir value_email e mencionar o nome do parâmetro com esse valor

Para especificar qual variável contém user_id você precisa transferir value_user_id e mencionar o nome do parâmetro com esse valor

Para especificar qual variável contém group_id você precisa transferir value_group_id e mencionar o nome do parâmetro com esse valor

Exemplo:

Digite no endereço value_client_id = my_client

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}

A consulta será equivalente à consulta abaixo:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}

Como você pode ver, o nome do parâmetro que contém o nome é diferenciado pelo prefixo value_

Como iniciar o bot

A inicialização do bot

POST https://chatter.mavibot.ai/api/<api_key>/callback

O método pode ser usado para iniciar o fluxo de trabalho para o cliente ou para aprovar a ação em um serviço de terceiros. Esta mensagem não ficará visível para o cliente.
Parâmetros adicionais transferidos são salvos nas variáveis.
O método para enviar o callback agora pode ser ativado compartilhando um e-mail (client_email) ou o número de telefone do cliente (client_phone)

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Corpo da Requisição

Nome Tipo Descrição
client_phone string número de telefone pelo qual o cliente é encontrado
client_email string e-mail pelo qual o cliente é encontrado
client_id string id do cliente no editor
message string o texto da mensagem

**200: OK **

import requests
import json
 
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/callback'
requests.post(url, json=params)

Iniciando o bot pelo número no WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

Este método inicia o bot no WhatsApp após o cliente se registrar através do site ou após deixar uma solicitação com seu número de telefone
Parâmetros adicionais transferidos são salvos nas variáveis

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Corpo da Requisição

Nome Tipo Descrição
name string o nome do cliente
message string o texto da mensagem
phone string o número de telefone do cliente
bot_id string o id do bot

**200: OK **

{
    // Response
}

Inicialização do bot através do id do Telegram

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

O método pode ser usado para iniciar o fluxo de trabalho ou confirmar ações em um site de terceiros. Esta mensagem não ficará visível para o cliente.

Parâmetros adicionais transferidos são salvos nas variáveis

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Corpo da Requisição

Nome Tipo Descrição
message string o texto da mensagem
user_id string o id do usuário no Telegram
group_id string o nome do bot (deve terminar em bot)

**200: OK **

{
    // Response
}

Como trabalhar com mensagens

Parâmetros para enviar mensagens

attachment_type pode assumir estes valores: image, video, link, file, audio
Ao enviar anexos, o parâmetro message não é obrigatório

buttons identifica os botões que serão anexados à mensagem. O formato dos botões é comparável às configurações avançadas do botão. Duas variantes de transmissão dos botões são possíveis: uma com a dica em mensageiros sem botões e outra sem ela

Aqui está um exemplo do parâmetro buttons:

"buttons": {"hint": "This text will be shown in Whatsapp",
 "buttons": [
    {"type": "reply", 
     "text": "What services we can provide", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Payment info", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "Our contact info", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "Leave an application", 
     "line": 1, "index_in_line": 1}
   ] 
}

Enviando a mensagem para o cliente

POST https://chatter.mavibot.ai/api/<api_key>/message

Este método pode ser usado para enviar mensagens com notificações. O parâmetro message é obrigatório se você não estiver enviando um arquivo. Se estiver, o texto não é necessário

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
message_id string o número do bloco de envio
message string o texto da mensagem
client_id string o id do cliente no editor
attachment_type string o tipo de exibição do arquivo
attachment_url string a URL do arquivo
buttons object botões

**200: OK **

import requests
import json

params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

Enviando mensagens no WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

Permite enviar uma mensagem em nome do bot conectado para o número mencionado whatsapp_bot_id deve ser obtido na seção “Mensageiros e chats”. Cada página do WhatsApp conectada recebe uma identificação única

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
message_id string o número do bloco de envio
whatsapp_bot_id number o bot do WhatsApp que envia a mensagem
attachment_url string a url do arquivo
attachment_type string o tipo de exibição do arquivo
message string o texto da mensagem
phone string o número de telefone do destinatário

**200: OK **

import requests
import json

params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)

Enviando mensagens em massa

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

O método permite a distribuição de mensagens. Se o parâmetro clients não for mencionado, a transmissão será enviada para todos os usuários. É necessário enviar um arquivo ou um texto

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
message_id string o número do bloco de envio
list string a lista de números dos destinatários
shift string a quantidade de segundos entre as mensagens. 0.2 por padrão
message string o texto da mensagem
clients array os ids dos destinatários
attachment_type string o tipo de exibição do arquivo
attachment_url string a URL do arquivo
buttons string botões

**200: OK **

{import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

Obtendo o histórico de mensagens

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

Obtendo o histórico de mensagens. Você pode obter o parâmetro client_id AQUI

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Parâmetros de Consulta

Nome Tipo Descrição
client_id string o id do cliente

**200: OK **

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "CouCou",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true"
    },
  ]
}

Limpando o histórico de mensagens

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Parâmetros de Consulta

Nome Tipo Descrição
client_id string o id do cliente

**200: OK **

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)

Como distribuir os clientes

Atribuindo um cliente a um funcionário

GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user

O método permite atribuir um cliente a um funcionário. O parâmetro de e-mail é opcional. Se o e-mail não for fornecido, será distribuído através do algoritmo do sistema

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Parâmetros de Consulta

Nome Tipo Descrição
client_id String o id do cliente
e-mail String o e-mail do trabalhador (opcional)

**200: OK **

import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

Carregando clientes no sistema

GET https://chatter.mavibot.ai/api/<api_key>/load_clients

O método permite carregar clientes no sistema. Ao carregar clientes do WhatsApp, você pode transferir o número livremente com o @s.whatsapp.net no final ou sem ele.

Você pode obter o id do grupo (group_id) aqui através de /api/<api_key>/connected_channels

(se client_type=13 (telefonia) então group_id=””)

Você pode ver o tipo de mensageiro de onde o cliente veio (client_type)

Ex.: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
platform_id String o número de telefone
group_id String o id do grupo
client_type String o tipo de mensageiro de onde o cliente veio

**200: OK **

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'

params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# in case of success the function returns each element its id and addition status
# answer example
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Adicionando clientes à lista

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
list_id integer o número da lista
clients array a matriz de números dos clientes

**200: OK **

{
    // Response
}

Removendo clientes da lista

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
list_id integer o número da lista
clients array a matriz de números dos clientes

**200: OK **

{
    // Response
}

Obtendo a lista de clientes

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Parâmetros de Consulta

Nome Tipo Descrição
offset string deslocamento do primeiro elemento
limit integer a quantidade de elementos na resposta. 500 por padrão, máx. 500
list string o número da lista

200: OK Retorna o status dos elementos e a matriz

{
"status":"success",
"clients":[{
    "id":44483,
    "platform_id":"146467928",
    "client_type":0,
    "name":null,
    "avatar":null,
    "message_id":null,
    "project_id":1,
    "created_at":1588248599,
    "updated_at":1588248599,
    "custom_answer":null,
    "tag":null,
    "group":"143414131",
    "operator_start_dialog":null
    }
]
}

Obtendo a lista de assinantes em qualquer mensageiro

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

Obtendo informações sobre os clientes no mensageiro escolhido

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Parâmetros de Consulta

Nome Tipo Descrição
page integer
tag string a tag que foi mencionada na página de inscrição
group integer o id do grupo ao qual o assinante está vinculado
date_from integer timestamp da data após a qual eles se inscreveram
date_to integer timestamp da data até a qual eles se inscreveram
client_type integer o id do mensageiro para o qual você precisa da sub-lista. se você não mudar nada, todos os clientes aparecem

**200: OK **

[
  {
    "id": 44886,
    "tag": null,
    "created_at": 1609867984,
    "name": "John Smith",
    "tg_id": "146467928",
    "group": "155824294",
    "variables": null
  },
  {
    "id": 44889,
    "tag": null,
    "created_at": 1609867984,
    "name": "Jane Austen",
    "tg_id": "1609867984",
    "group": "155824294",
    "variables": {
      "utm_source": "some_value"
    }
  }
]

Permissão para excluir clientes

POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients

Permissão de acesso ao gerar a chave: “Permissão para excluir clientes”

Parâmetros

Caminho
api key* — token de acesso

Corpo
client_ids — lista de IDs de clientes a serem excluídos. Máximo 500. Exemplo: [199571, 199707, 1935722]

Como trabalhar com variáveis

Atribuindo variáveis

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

Permite salvar variáveis no aplicativo e no cliente.
A requisição de atribuição de variáveis, por padrão, adiciona às variáveis de transação.
Se você precisar alterar as variáveis no perfil, precisa adicionar o prefixo client.
Ex. para mobile: client.phone

O parâmetro clients permite atribuir variáveis em massa

Ex.: {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
clients array matriz de ids de clientes para atribuir variáveis
client_id string id do cliente
variables object hash de variáveis (chave valor)

**200: OK **

import requests
import json

params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)

Obtendo variáveis

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Parâmetros de Consulta

Nome Tipo Descrição
client_id string id do cliente

**200: OK **

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)

Como obter client_id

Obtendo client_id pelo valor de platform_id

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

O método retorna o id do cliente para executar requisições à API

Exemplo de parâmetros: {"platform_ids": ["571830542", "256865200"]}

Parâmetros de Caminho

Nome Tipo Descrição
string chave de acesso

Corpo da Requisição

Nome Tipo Descrição
platform_ids string matriz de ids no mensageiro

**200: OK **

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\\/\\/files.mavibot.pro\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@wildeo"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\\/\\/files.mavibot.pro\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]

Como obter o id do cliente no chat online

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

Este método permite integrar o site e o chatbot, ou seja, se uma pessoa acessou a página com a oferta especial, você pode enviar instantaneamente uma mensagem sobre a oferta no chat

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Parâmetros de Consulta

Nome Tipo Descrição
tag string tag do cliente
name string o nome do cliente
recipient string o id do diálogo no site

**200: OK **

{ "client_id": 36553 }

Onde você obtém o recipient? No site que possui o chat online “Mavibot.ai”, você precisa obter o recurso MaviBotPro.recipient_id com a ajuda de JS.

Como obter o id do cliente com o número do WhatsApp

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

O método retorna o id do cliente para executar requisições à API se você souber o número de telefone do cliente no WhatsApp.
Se não houver nenhum cliente com esse número, você receberá um 404.

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Parâmetros de Consulta

Nome Tipo Descrição
phone string o número de telefone

**200: OK **

{
    // Response
}

Obtendo o id do cliente com o número de telefone

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

O método retorna o id do cliente para executar requisições à API.
A busca ocorre através de clientes do WhatsApp, bem como através de variáveis.

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Parâmetros de Consulta

Nome Tipo Descrição
phone string o número de telefone

**200: OK **

{
    // Response
}

Obtendo o id do cliente através do e-mail

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

O método retorna o id do cliente para executar requisições à API. A busca ocorre através de variáveis.

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Parâmetros de Consulta

Nome Tipo Descrição
email string e-mail para busca

**200: OK **

{
    // Response
}

Obtendo o id do cliente pelo valor da variável

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

O método retorna o id do cliente para executar requisições à API

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Parâmetros de Consulta

Nome Tipo Descrição
var string o nome da variável pela qual a busca será feita
val string o valor da variável

**200: OK **

{
    // Response
}

Que outras possibilidades existem

Movendo a transação para o estado do MavibotCRM

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

O número da transação pode ser obtido na janela de edição do fluxo de trabalho do MavibotCRM.

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
client_id string id do cliente
state_id string o número do estado para o qual transferir a transação do cliente

**200: OK **

{
    // Response
}

Verificando se a pessoa segue a conta do Instagram

GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription

Pode ser chamado tanto com o método POST quanto com o método GET

Parâmetros de Caminho

Nome Tipo Descrição
api_key string a chave de acesso

Corpo da Requisição

Nome Tipo Descrição
user_name string o nome de usuário do cliente que você deseja verificar
login string o login do bot que está sendo verificado

200: OK O campo is_follower é o que contém a informação se a pessoa segue ou não

{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}

Verificando se o número de telefone possui WhatsApp

GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp

Para usar o método, você PRECISA ter o WhatsApp e o Mavibot conectados

Pode ser chamado tanto com o método POST quanto com o método GET
O número de telefone pode ser transferido em qualquer formato

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

Corpo da Requisição

Nome Tipo Descrição
phone string o número de telefone

**200: OK **

{
    // Response
}

Obtendo a lista de mensageiros conectados ao projeto (incluindo group_id)

GET https://chatter.mavibot.ai/api/<api_key>/connected_channels

A função retorna o parâmetro group_id para cada mensageiro, e é ele que precisa ser transferido ao carregar os clientes

O campo status também retorna para o WhatsApp, e contém um valor de:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

**200: OK **

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'mavibotstage', 
        'name': 'mavibotstage', 
        'enabled': true,
        'group_id': 11}], 
'facebook': [], 
'telegram': [{
        'id': 23, 
        'short_name': 'bulls_vs_bears_bot', 
        'name': 'bulls_vs_bears_bot', 
        'enabled': true,
        'group_id': 'bulls_vs_bears_bot'}], 
'whatsapp': [] 
}

Obtendo a lista de blocos do esquema do bot

GET https://chatter.mavibot.ai/api/<api_key>/get_messages

Parâmetros de Caminho

Nome Tipo Descrição
api_key string token de acesso

**200: OK **

{
    // Response
}

Se você precisar de métodos adicionais, entre em contato com o suporte ao cliente