Skip to main content
API docs by Redocly

API Services (1.0.0)

Download OpenAPI specification:Download

Informações

O que é o API-Services:

Com o API-Services, podemos fazer a manipulação do banco de dados, criando, retornando e até atualizando documentos dentro do MongoDB. Também podemos criar usuários para realizar essas tarefas e enviar mensagens de texto.

Como usar:

Para começar a manipular o Banco de dados, basta criar um novo usuário na guia Usuários. Esse endpoint retornará um Apikey de usuário, que deve ser inserido no Header da sua requisição.

Banco de dados

Criar documento

Cria um documento dentro de uma collection.

Authorizations:
x-api-key
Request Body schema: application/json
owner
string

Proprietário da collection

collection
string

Nome da collection que deseja enviar o documento

object

Dados/Documentos a serem guardados nessa collection

Responses

Request samples

Content type
application/json
{
  • "owner": "Exemplo",
  • "collection": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "owner": "Exemplo",
  • "body": {
    },
  • "_id": "string",
  • "createdAt": "string",
  • "udpateAt": "string",
  • "__v": 0
}

Obter documento através do id

Retorna o documento com o id passado nos parâmetros.

Authorizations:
x-api-key
path Parameters
database
required
any

Nome da collection

key
required
any

ID do documento que deseja ver

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner": "string",
  • "body": {
    },
  • "createdAt": "string",
  • "udpateAt": "string",
  • "__v": 0
}

Obter documentos da collection

Retorna todos os documentos dentro da collection.

Authorizations:
x-api-key
path Parameters
database
required
any

Nome da collection

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner": "string",
  • "body": {
    },
  • "createdAt": "string",
  • "udpateAt": "string",
  • "__v": 0
}

Atualizar um documento da collection

Atualiza os dados de um documento dentro de determinada collection.

Authorizations:
x-api-key
path Parameters
database
required
any

Nome da collection

key
required
any

ID do documento que deseja atualizar

Request Body schema: application/json
object
documento
number
nome
string

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner": "string",
  • "body": {
    },
  • "createdAt": "string",
  • "udpateAt": "string",
  • "__v": 0
}

Deletar um documento da collection

Deleta um documento da collection selecionada.

Authorizations:
x-api-key
path Parameters
database
required
any

Nome da collection

key
required
any

ID do documento que deseja deletar

Responses

Response samples

Content type
application/json
{
  • "message": "Collection permission denied"
}

Sms

Enviar um SMS

Envia um SMS ao número informado.

Request Body schema: application/json
to
string

Número de telefone a ser enviada a mensagem

message
string

Mensagem a ser enviada

Responses

Request samples

Content type
application/json
{
  • "to": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "to": "string",
  • "message": "string"
}

Usuários

Adicionar novo usuário

Adiciona um novo usuário para manipular o Banco de Dados.

Request Body schema: application/json
name
string

Nome do usuário

amount
number

Quantidade de requisições que o usuário pode fazer

Responses

Request samples

Content type
application/json
{
  • "name": "Carlos",
  • "amount": 200
}

Response samples

Content type
application/json
{
  • "Name": "Carlos",
  • "Amount": 200,
  • "ApiKey": "315ad483-d449-4ec7-bd99-2dfc4fa480c3",
  • "Type": "User"
}

Atualizar um usuário

Atualiza os dados de um usuário já existente.

Request Body schema: application/json
apikey
string

APIKey gerada no endpoint -> Adicionar novo usuário

name
string

Novo nome do usuário

amount
number

Nova quantidade de requisições do usuário

Responses

Request samples

Content type
application/json
{
  • "apikey": "315ad483-d449-4ec7-bd99-2dfc4fa480c3",
  • "name": "Carlos",
  • "amount": 300
}

Response samples

Content type
application/json
{
  • "Id": 12,
  • "Name": "Carlos",
  • "Amount": 300,
  • "ApiKey": "315ad483-d449-4ec7-bd99-2dfc4fa480c3"
}

Campanha

Enviar campanha

Request Body schema: application/json
organization
string
bot
string
stage
string
bucket
string
path
string
fields
Array of arrays
object

Responses

Request samples

Content type
application/json
{
  • "organization": "string",
  • "bot": "string",
  • "stage": "string",
  • "bucket": "string",
  • "path": "string",
  • "fields": [ ],
  • "sender": {
    }
}

Conversas Orquestrador

Obter conversa do orquestrador

Mostra as conversas no orquestrador do bot e userId de uma data inicial específica.

path Parameters
bot
required
any

Nome do bot/agente

costumer_id
required
any

UserID que deseja ver a conversa

Request Body schema: application/json
initialDate
string

Responses

Request samples

Content type
application/json
{
  • "initialDate": "2022-11-07T18:00:23.962Z"
}

Response samples

Content type
application/json
{
  • "messages": [ ]
}