Documentação da API

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

 
Obtenha sua própria chave de API

Autenticação

Todas as solicitações de API exigem autenticação por meio de uma chave de API enviada através do cabeçalho Authorization como mostrado abaixo.

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

Erros

Nossa API utiliza 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 Solicitação concluída com sucesso
400 Pedido inválido - Parâmetros necessários estão ausentes ou são inválidos
401 Não autorizado - A chave da API está faltando ou é inválida
404 O recurso solicitado não foi encontrado
429 Muitos pedidos - Limite de taxa excedido
500 Erro interno do servidor - isso significa que há um problema do nosso lado
Todos os resultados de endpoint da API funcionam com o fuso horário UTC, a menos que especificado de outra forma.
Usuário
Links
Estatísticas de links
Projetos
Pixels
Páginas splash
Código QR
Dados
Manipuladores de notificações
Domínios personalizados
Minhas equipes
Membros da equipe
Membro das equipes
Pagamentos de contas
Registros da conta