Documentação da biblioteca de APIs
Boas vindas 👋
Bem-vindo à documentação das APIs SERP! Aqui você encontrará todas as informações necessárias para integrar e utilizar nossos serviços de forma eficiente.
Visão Geral
Comunicação
Nossas APIs utilizam JSON (JavaScript Object Notation) como formato principal para comunicação de dados. Em alguns casos, também aceitamos o formato application/x-www-form-urlencoded. Isso proporciona flexibilidade na troca de informações e na integração com diferentes sistemas.
Token
Para acessar rotas privadas, é necessário incluir um token de autorização no cabeçalho da solicitação. Utilize o esquema Authorization Bearer para fornecer este token.
Nosso método HTTP
As APIs SERP são organizadas com base no REST API. Os verbos HTTP mais comuns usados (ou métodos) são apresentados com um ícone para identificar o método da solicitação (Exemplo: GET, POST).
Método HTTP
As APIs SERP seguem a arquitetura REST. Os métodos HTTP mais comuns utilizados são representados por ícones para facilitar a identificação, tais como:
- GET: Para recuperar informações.
- POST: Para criar novos recursos.
- PUT: Para atualizar recursos existentes.
- DELETE: Para remover recursos.
Resposta HTTP
Cada solicitação às APIs retorna uma resposta HTTP que indica o sucesso ou a falha da operação. A resposta inclui um código de status HTTP e, frequentemente, uma mensagem que descreve o resultado da solicitação.
Códigos de Resposta Comuns
Aqui estão alguns dos códigos de resposta mais comuns que você pode encontrar:
- 200 - OK: A solicitação foi bem-sucedida. O resultado solicitado está incluído na resposta.
- 400 - Solicitação Inválida: Não foi possível processar sua solicitação devido a um erro no pedido. Por exemplo, uma solicitação para recuperar uma foto de usuário falhou.
- 401 - Não Autorizado: A solicitação requer autenticação, que não foi fornecida ou é inválida.
- 403 - Proibido: A solicitação é válida, mas o acesso é negado. Por exemplo, falha ao recuperar dados do cartório.
- 500 - Erro Interno do Servidor: Ocorreu um erro inesperado no sistema. Por favor, tente novamente mais tarde.
