Erros e limites - Sauddy API

Formato do erro

Toda resposta de erro usa um código HTTP diferente de 2xx e o corpo abaixo:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": ["cpf should not be empty", "cpf must be a string"],
  "path": "/v1/TeleMedicina/Adesao"
}

Campo	Tipo	Descrição
`statusCode`	number	Mesmo valor do código HTTP.
`error`	string	Nome do erro HTTP.
`message`	string ou array	Descrição do problema. Em erros de validação é uma lista com um item por problema.
`path`	string	Caminho chamado.

Códigos HTTP

HTTP	Significado	O que fazer
`200` / `201`	Sucesso	Leia o campo `data`.
`400`	Requisição inválida: campo ausente, vazio, com tipo errado, não documentado, CPF inválido ou `codigoOnix` fora da lista de Planos	Corrija os dados conforme `message`. Não repita a mesma requisição.
`401`	Credenciais inválidas no login, ou token ausente, inválido ou expirado	No login, confira `apiKey` e `companyId`. Nos demais endpoints, faça um novo login e repita uma vez.
`404`	Contrato não encontrado, ou caminho inexistente	Confira CPF, `numeroCartao`, `codigoOnix` e a URL.
`429`	Limite de requisições excedido	Aguarde e tente novamente mais tarde. Reaproveite o token.
`500`	Erro interno	Tente novamente após alguns instantes. Se persistir, contate a Sauddy.
`503`	A rede de telemedicina não confirmou a operação	Tente novamente após alguns minutos.

Mensagens comuns

`message`	Causa
`apiKey ou companyId inválidos.`	Credenciais incorretas, empresa inativa ou acesso à API desativado.
`Token não informado.`	Cabeçalho `Authorization: Bearer <token>` ausente.
`Token inválido ou expirado.`	Token expirado (mais de 15 minutos) ou corrompido. Faça novo login.
`CPF inválido.`	CPF com menos de 11 dígitos.
`Contrato não encontrado.`	Nenhum contrato da sua empresa com esse CPF, cartão e plano.
`property <campo> should not exist`	Campo não documentado no corpo da requisição.
`<campo> should not be empty`	Campo obrigatório ausente ou vazio.
`ThrottlerException: Too Many Requests`	Limite de requisições excedido.

Limites de requisições

Endpoint	Limite	Contado por
`POST /v1/Authorization/Login`	5 requisições a cada 15 minutos	Endereço IP
Demais endpoints	600 requisições por minuto	Sua empresa (soma de todas as chamadas autenticadas)

Boas práticas:

Reaproveite o token por até 15 minutos em vez de fazer login a cada chamada.
Ao receber 401 por token expirado, faça um novo login e repita a requisição uma única vez.
Use timeouts generosos na adesão (90 s) e na alteração de status (120 s).
Registre o path, o código HTTP e a message dos erros para facilitar o suporte.

Status do contrato