Documentação da API

Aprenda como conectar e integrar com nossa API.

 
Obtenha sua própria chave API

Autenticação

Todas as requisições da API exigem autenticação por meio de uma chave de API enviada via o cabeçalho Autorização como mostrado abaixo.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://bio.n2brasil.com.br/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 necessários estão faltando ou são inválidos
401 Não autorizado - Chave de API está faltando ou é inválida
404 O recurso solicitado não foi encontrado
429 Muitas requisições - Limite de taxa excedido
500 Erro interno do servidor - isso significa que há um problema em nosso lado
Todos os resultados dos endpoints 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 de splash
Códigos QR
Dados
Manipuladores de notificação
Logs da conta