Cabeçalho HTTP personalizado

Saiba mais sobre como funciona a política Cabeçalho HTTP personalizado na Digibee Integration Platform.

Os cabeçalhos HTTP são um par de chave-valor que fornece informações importantes sobre a solicitação ou resposta, como o tipo de conteúdo enviado, o método usado, os dados de autenticação e muito mais.

Na Digibee Integration Platform, a política Cabeçalho HTTP personalizado permite especificar cabeçalhos personalizados que não são definidos pelo padrão HTTP e são retornados quando uma solicitação é feita ao endpoint do trigger do pipeline. Este endpoint está disponível nos detalhes do pipeline implantado em Run. Desta forma, cada vez que o pipeline receber uma solicitação, a resposta conterá os cabeçalhos especificados na política.

Ao adicionar cabeçalhos personalizados, você pode incluir metadados ou instruções adicionais específicas aos requisitos da sua integração. Você também pode definir diferentes pares de chave-valor para cabeçalhos de produção e outros ambientes.

Como configurar uma política Cabeçalho HTTP personalizado

Siga estas etapas para configurar uma política Cabeçalho HTTP personalizado:

  1. Na página inicial da plataforma, clique em Administração no canto superior direito.

  2. Clique em Políticas.

  3. Clique na aba Transformação.

  4. Abra a política Cabeçalho HTTP personalizado. Você verá uma configuração diferente para cada ambiente.

  5. Ative a opção Não substituir a configuração do cabeçalho do pipeline pela nova configuração a seguir se você não quiser substituir os valores dos cabeçalhos configurados nos pipelines pelos valores dos cabeçalhos da política. Se você mantiver esta opção desativada, os valores serão substituídos.

Os cabeçalhos só serão substituídos se tiverem a mesma chave na política e no pipeline. Se não tiverem a mesma chave, os cabeçalhos do pipeline e da política serão somados na resposta.

  1. Clique em Add chave e valor para adicionar um novo par de informações de chave-valor. Insira os dados nos campos de key e value correspondentes.

  2. Você pode excluir qualquer par de chave-valor clicando no ícone X.

Pode levar alguns minutos para que os cabeçalhos sejam aplicados a todos os pipelines.

Você pode editar a política a qualquer momento seguindo as etapas descritas acima ou visualizar a configuração no modo somente leitura clicando no ícone de olho.

Caso de uso: substituindo a configuração do cabeçalho do pipeline pela configuração da política

Situação 1: você não deseja substituir a configuração do cabeçalho do pipeline

Suponha que você queira que todos os seus pipelines mostrem seus projetos nos cabeçalhos de resposta, e se o projeto não estiver definido no cabeçalho dos pipelines, ele deverá mostrar projeto: padrão.

Neste caso, esta deve ser a configuração da política:

  • Opção Não substituir a configuração do cabeçalho do pipeline pela nova configuração a seguir ativada.

  • Par de chave-valor: projeto: padrão.

Isto significa que os valores configurados nos pipelines individuais substituirão os valores definidos na política. Então, se você criar um pipeline e adicionar o par chave-valor projeto: digibee, o cabeçalho do pipeline terá precedência sobre o cabeçalho configurado na política. No entanto, se você não adicionar um cabeçalho que contenha a chave projeto no seu pipeline, o cabeçalho projeto: padrão será retornado na resposta em vez disso.

Situação 2: você deseja substituir a configuração do cabeçalho do pipeline

Agora vamos supor que você sempre queira exibir o cabeçalho projeto: padrão na resposta, independentemente do cabeçalho projeto: digibee estar configurado no pipeline.

Neste caso, esta deve ser a configuração da política:

  • Opção Não substituir a configuração do cabeçalho do pipeline pela nova configuração a seguir desativada.

  • Par de chave-valor: projeto: padrão.

Isso significa que, independentemente da configuração do pipeline conter a chave projeto com um valor específico, o cabeçalho projeto: padrão configurado na política será exibido na resposta da solicitação.

Atualizado