Documentação da API

Saiba como se conectar e integrar com a nossa API.

Obtenha sua própria chave de API

URL base

Autenticação

Todos os endpoints da API exigem uma chave de API enviada pelo método de autenticação Bearer.

Authorization: Bearer {api_key}

Exemplo

curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Nossa API usa códigos de status HTTP convencionais para indicar o sucesso ou a falha de uma solicitação.

Exemplo

{
    "errors": [
        {
            "title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
            "status": 401
        }
    ]
}

Códigos de status

200 Solicitação concluída com sucesso

400 Solicitação inválida: parâmetros obrigatórios ausentes ou inválidos

401 Não autorizado: chave de API ausente ou inválida

404 O recurso solicitado não foi encontrado

429 Muitas solicitações: limite de taxa excedido

500 Erro interno do servidor: há um problema do nosso lado

Todos os resultados dos endpoints da API usam o fuso horário UTC, salvo indicação em contrário.

Usuário

Equipes

Membros da equipe

Membro de equipes

Registros da conta