Política FlowCallout

Verificar a chave de API no fluxo compartilhado

Neste exemplo, um fluxo compartilhado é usado para executar tarefas comuns relacionadas à segurança. Aqui, o fluxo compartilhado valida uma chave de API. Os proxies da API e outros fluxos compartilhados podem usar a política FlowCallout para fazer chamadas para esse fluxo compartilhado.

A definição do fluxo compartilhado a seguir inclui uma política Verify-API-Key que é executada quando o fluxo compartilhado é chamado a partir de uma política FlowCallout em um proxy de API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SharedFlow name="default">
    <Step>
        <Name>Verify-API-Key</Name>
    </Step>
</SharedFlow>

A política VerifyAPIKey no fluxo compartilhado anterior recupera o valor da chave e o verifica.

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key">
    <DisplayName>Verify API Key</DisplayName>
    <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

A seguinte política de FlowCallout, usada em um proxy de API, chama o fluxo compartilhado anterior para verificar a chave de API. O pacote de fluxo compartilhado verify-apikey-shared (não mostrado aqui) configura o fluxo compartilhado da mesma maneira que um pacote APIProxy configura um proxy.

<FlowCallout async="false" continueOnError="false" enabled="true" name="Auth-Flow-Callout">
    <DisplayName>Auth Flow Callout</DisplayName>
    <SharedFlowBundle>verify-apikey-shared</SharedFlowBundle>
</FlowCallout>

Transmitir parâmetros para um fluxo compartilhado

Neste exemplo, ilustramos como transmitir parâmetros de uma política de FlowCallout para um fluxo compartilhado. Aqui, uma política de FlowCallout chama um fluxo compartilhado projetado para executar funções comuns de manipulação de strings. O fluxo compartilhado inclui JavaScript que concatena a entrada, reduz a entrada, ou ambos. A política FlowCallout define parâmetros que especificam a entrada, a saída de string e o que fazer com a entrada.

1. A política FlowCallout String-Handler chama o fluxo compartilhado, passando parâmetros especificando a variável para armazenar a saída do fluxo compartilhado, qual operação de fluxo compartilhado usar e qual entrada usar. Aqui, um literal de string, mas também pode ser uma variável de fluxo. Os elementos Parameter especificam os nomes e valores das variáveis para criar o ambiente de execução. O fluxo compartilhado pode recuperar essas variáveis para uso no próprio código.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
     <DisplayName>String Handler</DisplayName>
     <Parameters>
       <Parameter name="input">Gladys Kravitz</Parameter>
       <Parameter name="operations">concatenate tolowercase</Parameter>
       <Parameter name="outputVariable">string.handler.output</Parameter>
     </Parameters>
     <SharedFlowBundle>StringHandler</SharedFlowBundle>
   </FlowCallout>
   

2. O fluxo compartilhado default a seguir inclui uma política JavaScript SharedStringFunctions que é executada quando o fluxo compartilhado é chamado a partir de uma política FlowCallout.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <SharedFlow name="default">
     <Step>
       <Name>SharedStringFunctions</Name>
     </Step>
   </SharedFlow>

3. No fluxo compartilhado, a seguinte política JavaScript SharedStringFunctions especifica o arquivo JavaScript SharedStringFunctions.js com o código a ser executado.

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="SharedStringFunctions">
     <DisplayName>SharedStringFunctions</DisplayName> <Properties/>
     <ResourceURL>jsc://SharedStringFunctions.js</ResourceURL>
   </Javascript>

4. O seguinte JavaScript, SharedStringFunctions.js, é executado a partir da política JavaScript SharedStringFunctions. Esse script recupera valores de variáveis criadas a partir de elementos Parameter da política do FlowCallout.

   // Input value from the calling API proxy.
   var handledString = context.getVariable("input");
   // Variable to use for output from this script.
   var outputVariable = context.getVariable("outputVariable");
   // A space-separated list of things to do to the input string.
   // Convert to lower case to handle unintentional capitals in configuration.
   var operation = context.getVariable("operations").toLowerCase();
   
   // If "lowercase" was given as an operation, convert the input to lowercase.
   if (operation.includes("tolowercase")) {
       handledString = handledString.toLowerCase();
   }
   
   // If "concatenate" was given as an operation, concatenate the input.
   if (operation.includes("concatenate")) {
       handledString = handledString.replace(/\s+/g, '');
   }
   // Assign the resulting string to the output variable specified by
   // the calling API proxy.
   context.setVariable(outputVariable, handledString);

5. A execução volta da política do JavaScript para o fluxo compartilhado e depois para a política FlowCallout no proxy da API de origem.

Sintaxe

É possível usar esse elemento com qualquer um dos seguintes formulários de sintaxe. Observe que, quando você usa um valor literal, o formato do valor especificado depende do código que o consome.

<!- A literal value in an attribute. --/>
<Parameter name="parameter-name" value='parameter-value' />
<!- A reference to a variable in an attribute. --/>
<Parameter name="parameter-name" ref='source-variable-name' />
<!- A literal value in the element content. --/>
<Parameter name="parameter-name">parameter-value</Parameter>
<!- An reference to an attribute in the element content. --/>
<Parameter name="parameter-name">{source-variable-name}</Parameter>

Exemplo

Essa política de FlowCallout String-Handler transmite parâmetros que especificam onde armazenar a saída do fluxo compartilhado e qual entrada usar. Os elementos Parameter especificam os nomes e valores das variáveis para criar o ambiente de execução. O fluxo compartilhado pode recuperar essas variáveis para uso em seu próprio código.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<FlowCallout async="false" continueOnError="false" enabled="true" name="String-Handler">
  <DisplayName>String Handler</DisplayName>
  <Parameters>
    <Parameter name="input">Gladys Kravitz</Parameter>
    <Parameter name="outputVariable">string.handler.output</Parameter>
  </Parameters>
  <SharedFlowBundle>StringHandler</SharedFlowBundle>
</FlowCallout>

Sintaxe

<Parameters>
  <Parameter name="parameter-name" value='parameter-value' />
</Parameters>