Saltar para o conteúdo
ShopentlyLearn

Requisições e respostas

Interprete conjuntamente o estado HTTP, os tipos do conteúdo JSON e os metadados da requisição.

Pedido

Content-Type: application/json
Envie escritas JSON com Content-Type: application/json.
data · meta
Respostas bem-sucedidas contêm data e meta; respostas de coleções também descrevem a paginação.
error.code · error.message
Erros contêm error.code, error.message e informações dos campos quando aplicável.

Tipos de dados

  • Obrigatório e nullable são propriedades independentes.
  • Um campo obrigatório pode conter null quando o esquema permite.
  • Preserve os tipos JSON booleano, inteiro, texto e null sem conversões automáticas.
  • Valores monetários são textos decimais; não calcule preços usando ponto flutuante binário.

64-bit · expected_version

  • Algumas versões para controlo de concorrência usam inteiros com sinal de 64 bits.
  • Um cliente JavaScript deve processar JSON sem perda de precisão para valores acima de Number.MAX_SAFE_INTEGER e enviar a representação inteira original.
  • Não arredonde uma versão nem a converta em texto JSON.

Cabeçalhos

Cache-ControlTextoOpcional

Política de cache da resposta.

const: "no-store"
X-Correlation-IDTextoOpcional

Identificador usado para rastrear esta requisição HTTP.

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0
LocationTextoOpcional

URL relativa do recurso criado.