Documentação da API

Esta é a documentação para os endpoints da API disponível, que são construídos em torno do REST architecture. Todos os endpoints da API retornará um JSON response com o padrão HTTP response codes e precisa de um Bearer Authentication através de uma API Key.

 

Authentication

Todos os endpoints da API requerem uma API key enviado pelo método Bearer Authentication.

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

Erros

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

{
    "errors": [
        {
            "title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
            "status": 401
        }
    ]
}
200 Pedido concluído com sucesso
400 Pedido inválido - Parâmetros obrigatórios estão ausentes ou inválidos
401 Não autorizado - a chave da API está em falta ou inválida.
404 O recurso solicitado não foi encontrado
429 Pedidos em excesso - Limite de taxa excedido
500 Erro interno do servidor – isso significa que há um problema do nosso lado
Todos os resultados do endpoint da API funcionam com o fuso horário UTC a menos que seja especificado de outra forma.
Usuário
Links
Estatísticas de links
Projetos
Pixels
Páginas de Apresentação
Código QR
Assinaturas de Email
Dados
Manipuladores de notificações
Domínios Personalizados
Minhas Equipes
Membros da equipe
Membro da equipe
Meus Pagamentos
Atividades da Conta