Política IntegrationCallout

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Vista geral

A política IntegrationCallout permite-lhe executar uma integração de aplicações que tenha um acionador de API. No entanto, antes de executar uma integração, tem de executar a política SetIntegrationRequest. A política SetIntegrationRequest cria um objeto de pedido e disponibiliza o objeto à política IntegrationCallout como uma variável de fluxo. O objeto de pedido tem os detalhes de integração, como o nome do acionador da API, o ID do projeto de integração, o nome da integração e outros detalhes configurados na política SetIntegrationRequest. A política IntegrationCallout usa a variável de fluxo do objeto de pedido para executar a integração. Pode configurar a política IntegrationCallout para guardar a resposta de execução da integração numa variável de fluxo.

A política IntegrationCallout é útil se quiser executar a integração no meio do fluxo do proxy. Em alternativa, em vez de configurar a política IntegrationCallout, também pode executar uma integração especificando um ponto final de integração como o ponto final de destino. Para mais informações, consulte o artigo IntegrationEndpoint.

Esta política é uma política extensível e a utilização desta política pode ter implicações de custo ou utilização, consoante a sua licença do Apigee. Para ver informações sobre os tipos de políticas e as implicações de utilização, consulte Tipos de políticas.

<IntegrationCallout>

Especifica a política IntegrationCallout.

A tabela seguinte apresenta uma descrição geral dos elementos subordinados de <IntegrationCallout>:

O elemento <IntegrationCallout> usa a seguinte sintaxe:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<IntegrationCallout continueOnError="[true|false]" enabled="[true|false]" name=POLICY_NAME>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  <AsyncExecution>BOOLEAN_ASYNC_EXECUTION</AsyncExecution>
  <Request clearPayload="[true|false]">REQUEST_FLOW_VARIABLE_NAME</Request>
  <Response>RESPONSE_FLOW_VARIABLE_NAME</Response>
</IntegrationCallout>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<IntegrationCallout continueOnError="false" enabled="true" name="Integration-Callout">
  <DisplayName>Integration-Callout-1</DisplayName>
  <AsyncExecution>true</AsyncExecution>
  <Request clearPayload="true">my_request_flow_var</Request>
  <Response>my_response_flow_var</Response>
</IntegrationCallout>

Este elemento tem os seguintes atributos comuns a todas as políticas:

Referência de elemento secundário

<DisplayName>

Use em conjunto com o atributo name para etiquetar a política no editor de proxy da IU de gestão com um nome diferente e mais natural.

O elemento <DisplayName> é comum a todas as políticas.

O elemento <DisplayName> usa a seguinte sintaxe:

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

O elemento <DisplayName> não tem atributos nem elementos subordinados.

<AsyncExecution>

Especifica o modo de execução da integração. Pode executar a integração de forma síncrona ou assíncrona.

Se estiver definido como true, a integração é executada de forma assíncrona. Se estiver definido como false, a integração é executada de forma síncrona.

• Modo assíncrono: quando o pedido de execução da integração atinge o ponto final, este devolve imediatamente os IDs de execução da integração, mas inicia a execução da integração na hora especificada pelo elemento <ScheduleTime>. Se não tiver definido o elemento <ScheduleTime>, a integração é agendada para ser executada imediatamente. Embora a integração esteja agendada para ser executada imediatamente, a respetiva execução pode começar após alguns segundos. Quando a integração começa a ser executada, ocorrem as duas seguintes situações:
  • A integração devolve o Código de estado HTTP 200 OK para que o autor da chamada possa continuar o processamento.
  • A política IntegrationCallout é concluída.
  Depois de iniciada, a integração tem um limite de tempo máximo de 50 minutos para concluir a execução.
• Modo síncrono: quando o pedido de execução da integração atinge o ponto final, este inicia imediatamente a execução da integração e aguarda a resposta. O limite de tempo máximo para concluir a execução é de 2 minutos. Após a conclusão da execução, o endpoint devolve uma resposta com os IDs de execução e outros dados de resposta.

O elemento <AsyncExecution> usa a seguinte sintaxe:

<AsyncExecution>BOOLEAN</AsyncExecution>

<AsyncExecution>true</AsyncExecution>

<Request>

Especifica a variável de fluxo que tem o objeto de pedido criado pela política SetIntegrationRequest. A política IntegrationCallout envia este objeto de pedido para a solução Application Integration para executar a integração.

O elemento <Request> usa a seguinte sintaxe:

<Request clearPayload="true">FLOW_VARIABLE_NAME</Request>

<Request clearPayload="true">my_request_flow_var</Request>

A tabela seguinte descreve os atributos de <Request>:

<Response>

Especifica a variável de fluxo para guardar a resposta da integração.

Se não especificar este elemento, a política guarda a resposta na variável de fluxo integration.response.

O resultado da integração pode ser acedido pelo integration.response.content ou flow_variable.content. O elemento <Response> usa a seguinte sintaxe:

<Response>FLOW_VARIABLE_NAME</Response>

<Response>my_response_flow_var</Response>

Códigos de erro

Esta secção descreve os códigos de falhas, as mensagens de erro e as variáveis de falhas definidas pelo Apigee quando esta política aciona um erro. Estas informações são essenciais se estiver a desenvolver regras de falhas para resolver falhas. Para saber mais, consulte o artigo O que precisa de saber acerca dos erros de políticas e o artigo Processamento de falhas.

Erros de tempo de execução

Estes erros podem ocorrer quando a política é executada.

Variáveis de falha

Sempre que existem erros de execução numa política, o Apigee gera mensagens de erro. Pode ver estas mensagens de erro na resposta de erro. Muitas vezes, as mensagens de erro geradas pelo sistema podem não ser relevantes no contexto do seu produto. Pode personalizar as mensagens de erro com base no tipo de erro para tornar as mensagens mais significativas.

Para personalizar as mensagens de erro, pode usar regras de falhas ou a política RaiseFault. Para informações sobre as diferenças entre as regras de falhas e a política RaiseFault, consulte Regras de falhas vs. a política RaiseFault. Tem de verificar as condições através do elemento Condition nas regras de falhas e na política RaiseFault. O Apigee fornece variáveis de falhas exclusivas para cada política, e os valores das variáveis de falhas são definidos quando uma política aciona erros de tempo de execução. Ao usar estas variáveis, pode verificar condições de erro específicas e tomar as medidas adequadas. Para mais informações sobre a verificação das condições de erro, consulte o artigo Criar condições.

A tabela seguinte descreve as variáveis de falha específicas desta política.

Tópicos relacionados

Se quiser saber mais sobre a funcionalidade Application Integration, consulte o artigo Vista geral da Application Integration