Objeto "Header" definido em todas as solicitações enviadas ao servidor.
Representação JSON |
---|
{
"requestId": string,
"requestTimestamp": string,
"userLocale": string,
"protocolVersion": {
object ( |
Campos | |
---|---|
requestId |
OBRIGATÓRIO: identificador exclusivo da solicitação. Essa é uma string com tamanho máximo de 100 caracteres e apenas os caracteres "a-z", "A-Z", "0-9", ":", "-" e "_". |
requestTimestamp |
REQUIRED: carimbo de data/hora da solicitação representado como milissegundos desde a época. O receptor precisa verificar se esse carimbo de data/hora tem ± 60 s de "now". Esse carimbo de data/hora da solicitação não é idempotente em novas tentativas. |
userLocale |
OBSOLETO: um código de idioma ISO 639-2 Alfa 3 de duas ou três letras opcionalmente seguido por um hífen e um código de país ISO 3166-1 Alfa-2, por exemplo, 'pt', 'pt-BR', 'fil' ou 'fil-PH'. Use isso para ajudar a direcionar os campos |
protocolVersion |
OBRIGATÓRIO: a versão da solicitação. |
Versão
O objeto Version, que é uma forma estruturada da estrutura de versão clássica do a.b.c
. As principais versões do mesmo número têm garantia de compatibilidade. Pequenas e revisões podem ser alteradas com frequência e sem aviso prévio. O integrador precisa oferecer suporte a todas as solicitações para a mesma versão principal.
Representação JSON |
---|
{ "major": integer, "minor": integer, "revision": integer } |
Campos | |
---|---|
major |
OBRIGATÓRIO: versão principal. Isso é marcado para solicitações de compatibilidade com versões diferentes. |
minor |
OBRIGATÓRIO: versão secundária. Isso indica correções de bugs significativas. |
revision |
OBRIGATÓRIO: versão secundária. Isso indica pequenas correções de bugs. |