Cabeçalhos HTTP

Content-Type

Representa o formato do payload de requisição, por padrão/default definido como application/json;charset UTF-8. Obrigatório para chamadas PUT e POST. Os transmissores poderão implementar tratamento para outros padrões, sendo obrigatório apenas o suporte ao padrão.

Não

Accept

Especifica o tipo de resposta.
Se especificado, deve ser definido como application/json, a menos que o endpoint explicitamente suporte outro formato.
Se for definido um valor não suportado pelo endpoint, será retornado o código HTTP 406. Se não especificado, o padrão será application/json.

Não

Accept-Encoding

Especifica os tipos de encoding(geralmente algoritmo de compressão) que são suportados pelo cliente, com previsão de suporte ao gzip por parte dos transmissores, sendo que o padrão é a transmissão dos dados não compactados e esta orientação aplica-se aos Dados Abertos.

Não

If-Modified-Since

Condiciona o resultado da requisição para que o recurso só seja enviado caso tenha sido atualizado após a data fornecida. Utiliza o padrão da RFC 7232, sessão 3.3: If-Modified-Since do protocolo HTTP.

Não

x-fapi-auth-date

Data em que o usuário logou pela última vez com o receptor

Condicional

x-fapi-customer-ip-address

O endereço IP do usuário se estiver atualmente logado com o receptor

Condicional

x-fapi-interaction-id

Um UUID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta

Não

Authorization

Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado

Sim

x-idempotency-key

Cabeçalho HTTP personalizado. Identificador de solicitação exclusivo para suportar a idempotência

Condicional

x-customer-user-agent

Indica o user agent que o usuário utiliza

Condicional

Content-Encoding

Cabeçalho que indica o tipo de encoding (geralmente algoritmo de compressão) que foi utilizado para envio da resposta.

Não

Content-Type

Representa o formato do payload de resposta. Deverá ser application/json a menos que o endpoint requisitado suporte outro formato e este formato tenha sido solicitado através do cabeçalho Accept no momento da requisição.

Sim

x-v

Cabeçalho que indica a versão implementada da API pela instituição transmissora. Deve ser preenchido de forma completa, por exemplo: x-v : 1.0.2

Sim

Retry-After

Cabeçalho que indica o tempo (em segundos) que o cliente deverá aguardar para realizar uma nova tentativa de chamada. Este cabeçalho deverá estar presente quando o código HTTP de retorno for 429 Too many requests

Não

Last-Modified

Informa a data e hora em que o recurso foi modificado pela última vez. Utiliza o padrão da RFC 7232, sessão 2.2: Last-Modified do protocolo HTTP.

Não

x-fapi-interaction-id

Um UUID RFC4122 usado como um ID de correlação. O transmissor deve usar o mesmo valor recebido na requisição para o cabeçalho de resposta recebido na requisição, caso não tenha sido fornecido, deve se usar um UUID RFC4122

Não

x-rate-limit

Indica o limite de requisições na API no tempo

Condicional

x-rate-limit-remaining

Indica o número de requisições restantes

Condicional

x-rate-limit-time

Informa o tempo do limite ou tempo para reset desse limite

Condicional