Documentação da API

Aprenda como se conectar e integrar com nossa 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://utilifyweb.com/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 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 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 do nosso lado
Todos os resultados dos endpoints da API funcionam com o fuso horário UTC, salvo indicação em contrário.
Usuário
Logs da conta