Versions Compared

Old Version 2

changes.mady.by.user LUCAS GODAY

Saved on

compared with

New Version Current

changes.mady.by.user LUCAS GODAY

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A API usa os seguintes códigos HTTP para indicar retornos de sucesso comuns:

Status HTTPDescriçãoMétodo HTTP
200Indica que o processamento foi realizado corretamente e o retorno poderá ser consultado no corpo do HTTP ResponseGET
201Indica que o recurso foi criado com sucesso
, deverá existir o header Location: indicando a URI do novo recurso
POST
202
Indica que o processamento será assíncrono, portanto, além do header Location, deverá retornar o conteúdo com um atributo statusPOST, PUT e DELETE204Indica que o recurso foi alterado ou excluído com sucessoPUT e DELETE

Lista de Códigos de Erro

A API usa os seguintes códigos HTTP para indicar erros comuns:

Status HTTPDescrição
422Requisição Mal Formada, Exceções de campos obrigatórios!
400

Exceções de negócio! validar RestricoesCONs

401Requisição Requer Autenticação
403Requisição Negada404Recurso não Encontrado405Método não Permitido408Tempo esgotado para a requisição413Requisição excede o tamanho máximo permitido415Tipo de mídia inválida (falta de informar o content-type correto, ver JSON)429Requisição excede a quantidade máxima de chamadas permitidas à API500Erro de servidor

Os erros citados acima serão retornados no seguinte padrão:

...

iconfalse
{
    "errors": [
        {
            "code": "401.001",
            "type": "SecurityException",
            "message": "Você não tem permissão para acessar o recurso desejado",
            "skuSellerId": "" -- campo opcional
        }
    ]
}

Listagem de erros

Abaixo segue a lista completa de erros retornados pela API:

...

422Requisição Mal Formada, Exceções de campos obrigatórios!
500Erro de servidor