Verificar cabeçalho HTTP

  • Artigo
  • 2 minutos para ler

Utilize a check-header política para impor que um pedido tem um cabeçalho HTTP especificado. Opcionalmente, pode verificar se o cabeçalho tem um valor específico ou um de um intervalo de valores permitidos. Se a verificação falhar, a política termina o processamento de pedidos e devolve o código de estado HTTP e a mensagem de erro especificada pela política.

Nota

Defina os elementos da política e os elementos subordinados pela ordem indicada na declaração de política. Saiba mais sobre como definir ou editar políticas de Gestão de API.

Declaração de política

<check-header name="header name" failed-check-httpcode="code" failed-check-error-message="message" ignore-case="true | false">
    <value>Value1</value>
    <value>Value2</value>
</check-header>

Atributos

Atributo Descrição Obrigatório Predefinição
name O nome do cabeçalho HTTP a verificar. Yes N/D
failed-check-httpcode Código de estado HTTP para devolver se o cabeçalho não existir ou tiver um valor inválido. Yes N/D
failed-check-error-message Mensagem de erro a devolver no corpo de resposta HTTP se o cabeçalho não existir ou tiver um valor inválido. Esta mensagem tem de ter quaisquer carateres especiais corretamente escapados. Yes N/D
ignorar maiúsculas e minúsculas Booleano. Se definido como true, o caso é ignorado quando o valor do cabeçalho é comparado com o conjunto de valores aceitáveis. Yes N/D

Elementos

Elemento Descrição Obrigatório
valor Adicione um ou mais destes elementos para especificar valores de cabeçalho HTTP permitidos. Quando são especificados vários value elementos, a verificação é considerada um êxito se um dos valores for uma correspondência. No

Utilização

Exemplo

<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
    <value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>

Passos seguintes

Para obter mais informações sobre como trabalhar com políticas, consulte: