Documentação da API

Esta é a documentação para os 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://link.superplural.com/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 Solicitação concluída com sucesso
400 Requisição inválida - Parâmetros obrigatórios estão 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 solicitações - Limite de taxa excedido
500 Erro interno do servidor - isto significa que há um problema do nosso lado
Todos os resultados dos endpoints da API funcionam com o UTC timezone a menos que especificado de outra forma.
Usuário
Links
Estatísticas de links
Pixels
Páginas de introdução
QR Codes
Dados
Manipuladores de notificação
Domínios personalizados
Pagamentos de conta
Registros de conta