Sumary

Authorização

• A geração de tokens e credenciais de autorização desta API é realizada exclusivamente pela plataforma Integradores Farmacias Digitais. Esta aplicação não possui nenhum endpoint de autenticação próprio.
• Todos os endpoints desta API requerem o envio do token no header da requisição. O token deve ser incluído com a chave "Authorization" e seu respectivo valor, conforme o exemplo abaixo:

  Authorization: Bearer {seu_token_aqui}
  

Api

Esta API foi desenvolvida seguindo a metodologia Full REST, garantindo um padrão consistente de respostas e erros. Todos os erros retornados pela API seguem um formato padronizado, permitindo que os códigos de status sejam interpretados para compreender a resposta esperada.

O formato de erro adotado segue a especificação RFC 7807 documentação oficial. Sempre que ocorrer um erro, a resposta seguirá o modelo abaixo:

Objeto de Exemplo

{
  "type": "Erro do servidor",
  "title": "Erro de Sistema",
  "statusCode": 302,
  "retry-after": null,
  "detail": "Erro desconhecido.",
  "instance": "instanciaErro01",
  "urlRedirect": "https://exemplo.com/erro",
  "extensions": {
    "erroInterno": "Detalhes sobre o erro interno."
  },
  "validations": {
    "campo1": [
      "Campo inválido."
    ],
    "campo2": [
      "Valor não permitido."
    ]
  }
}

Padrões da aplicação

• Todas as requisições DELETE retornarão 204 - No Content, confirmando que a operação foi processada com sucesso.
• Métodos de listagem (GET) retornarão 204 - No Content caso nenhum objeto seja encontrado.
• Erros de validação serão retornados com 400 - Bad Request, e os campos inválidos serão detalhados no objeto "validations".
• Todo ID será gerado pela aplicação. Utilizamos a metodologia de DTOs, portanto:
  • Em métodos PUT, o envio do ID dentro do objeto principal não é necessário, pois ele será passado na rota.
  • Para objetos filhos, o ID deve ser enviado. Caso contrário, o sistema considerará o objeto como novo e tentará inseri-lo, caso ainda não exista no banco.