IA2S

Erros


Todo erro tem o formato { codigo, mensagem, campos? }. Use o codigo no seu programa: é estável. A mensagem é para pessoas, em português. O campos só vem no 400 e diz o que há de errado em cada campo.

{
  "codigo": "INVALIDO",
  "mensagem": "Confira os dados informados.",
  "campos": {
    "nome": "Campo obrigatório."
  }
}

Os códigos comuns

StatusCódigoQuando
400INVALIDOCorpo ou parâmetro inválido. Veja campos.
400CHAVE_IDEMPOTENCIA_INVALIDAA Idempotency-Key não tem de 1 a 255 caracteres visíveis, sem espaços.
401TOKEN_INVALIDOSem token, token desconhecido, revogado ou expirado.
403SEM_PERMISSAOA pessoa não pode fazer isto no escritório, ou não tem lá a permissão de usar a API.
403TOKEN_SO_LEITURAEscrita com token só de leitura.
403TOKEN_BLOQUEADOA administração do escritório do caminho bloqueou o token. Nos outros, ele continua.
403TOKEN_SEM_ESCOPOToken de escritório em uma operação que não foi marcada ao gerá-lo.
403TOKEN_AUTOR_INATIVOToken de escritório cuja pessoa que o gerou não está mais ativa nele.
404NAO_ENCONTRADONão existe, ou está fora do alcance da pessoa.
404ESCRITORIO_NAO_ENCONTRADOO código no caminho não é de um escritório em que a pessoa é membro ativo. Escritório de outros e código que não existe dão a mesma resposta.
409TENTE_NOVAMENTEOutra pessoa alterou isto ao mesmo tempo.
409CPF_EM_USOO CPF, o CNPJ (CNPJ_EM_USO) ou o número CNJ (NUMERO_EM_USO) já está em outro cadastro; veja cliente ou processo, quando você pode vê-los.
413CORPO_GRANDEO corpo da requisição é grande demais.
422CHAVE_IDEMPOTENCIA_REUTILIZADAA Idempotency-Key já foi usada com outro pedido.
429LIMITE_TOKENMais de 120 requisições no minuto.
503SISTEMA_OCUPADOO sistema está ocupado. Tente em instantes.

Regras de negócio têm códigos próprios, descritos em cada endpoint, como CONFIRMACAO_NECESSARIA e STATUS_TRAVADO.

Reenvio seguro (Idempotency-Key)

Se a conexão cair antes da resposta, você não sabe se o cadastro foi criado. Nas criações (os POST que gravam), envie o cabeçalho Idempotency-Key com uma chave única por operação, como um UUID. Se o mesmo pedido for reenviado com a mesma chave em até 24 horas, a resposta da primeira vez volta, com o cabeçalho Idempotent-Replayed: true, e nada é criado de novo.

  • A chave vale por token e por escritório. Pedido diferente com a mesma chave dá 422 CHAVE_IDEMPOTENCIA_REUTILIZADA.
  • Só respostas de sucesso ficam guardadas: se a primeira tentativa falhou, a nova executa.
  • Se receber 409 TENTE_NOVAMENTE, reenvie com a mesma chave.
  • A chave só vale em chamadas com token, pessoal ou de escritório. Com a sessão do portal, ela é ignorada.
  • Os 409 CPF_EM_USO, CNPJ_EM_USO e NUMERO_EM_USO não melhoram com reenvio: corrija o dado, ou use o cadastro que já existe.
  • O MCP não usa a chave.