Documentação da API

Esta é a documentação dos endpoints da API disponíveis, que são construídos em torno da arquitetura REST. Todos os endpoints da API retornarão uma resposta JSON com os códigos de resposta HTTP padrão e precisam de uma Autenticação Bearer via uma Chave de API.

 
Obtenha sua própria chave de API

Autenticação

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

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

Erros

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

{
    "errors": [
        {
            "title": "Voc\u00ea n\u00e3o tem acesso \u00e0 API.",
            "status": 401
        }
    ]
}
200 Requisição concluída com sucesso
400 Requisição inválida: parâmetros obrigatórios ausentes ou inválidos
401 Não autorizado: a chave de API está ausente ou é inválida
404 O recurso solicitado não foi encontrado
429 Muitas requisições: limite de requisições 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.
Utilizador
Links
Estatísticas de links
Projetos
Pixels
Páginas de introdução
Códigos QR
Assinaturas
Data
Notificações
Domínios personalizados
Minhas equipes
Membros da equipe
Membro da equipe
Registos da conta