FlowCallout-Richtlinie

API-Schlüssel im freigegebenen Ablauf prüfen

In diesem Beispiel wird ein freigegebener Ablauf verwendet, um allgemeine sicherheitsbezogene Aufgaben auszuführen. Hier wird der API-Schlüssel durch den freigegebenen Ablauf validiert. API-Proxys und andere freigegebene Abläufe können mit der FlowCallout Richtlinie Aufrufe an diesen freigegebenen Ablauf senden.

Die folgende Definition eines freigegebenen Ablaufs enthält eine Verify-API-Key-Richtlinie, die ausgeführt wird, wenn der freigegebene Ablauf über eine FlowCallout-Richtlinie in einem API-Proxy aufgerufen wird.

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

Die VerifyAPIKey-Richtlinie im vorherigen freigegebenen Ablauf ruft den Schlüsselwert ab und überprüft ihn.

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

Mit der folgenden FlowCallout-Richtlinie, die in einem API-Proxy verwendet wird, wird der vorherige freigegebene Ablauf aufgerufen, um den API-Schlüssel zu prüfen. Das freigegebene Ablauf-Bundle verify-apikey-shared (hier nicht gezeigt) konfiguriert den freigegebenen Ablauf so, wie ein API-Proxy-Bundle einen Proxy konfiguriert.

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

Übergeben Sie Parameter an einen freigegebenen Ablauf

In diesem Beispiel wird veranschaulicht, wie Sie Parameter aus einer FlowCallout-Richtlinie an einen freigegebenen Ablauf übergeben. Dabei ruft eine FlowCallout-Richtlinie einen freigegebenen Ablauf auf, der zur Ausführung gängiger Stringverarbeitungsfunktionen erforderlich ist. Der freigegebene Ablauf umfasst JavaScript, das seine Eingabe verkettet, seine Eingabe in Kleinbuchstaben einschränkt oder beides. Die FlowCallout-Richtlinie definiert Parameter, die die Eingabe, Ausgabe und die möglichen Aktionen für die Eingabe festlegen.

1. Die String-Handler FlowCallout-Richtlinie ruft den freigegebenen Ablauf auf. Dabei werden Parameter übergeben, mit denen die Variable zum Speichern der Ausgabe des freigegebenen Ablaufs, der zu verwendende freigegebene Ablaufvorgang und die zu verwendende Eingabe angegeben wird (hier ein String). Literal, kann aber auch eine Ablaufvariable sein. Die Parameter Elemente geben die Namen und Werte der Variablen an, um die Laufzeit zu erstellen. Der freigegebene Ablauf kann diese Variablen zur Verwendung in ihrem eigenen Code abrufen.

   <?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. Der folgende freigegebene Ablauf default enthält eine JavaScript-Richtlinie SharedStringFunctions, die ausgeführt wird, wenn der freigegebene Ablauf über eine FlowCallout-Richtlinie aufgerufen wird.

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

3. Im freigegebenen Ablauf gibt die folgende JavaScript-Richtlinie SharedStringFunctions die JavaScript-Datei SharedStringFunctions.js mit dem auszuführenden Code an.

   <?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. Das folgende JavaScript, SharedStringFunctions.js, wird über die SharedStringFunctions JavaScript-Richtlinie ausgeführt. Dieses Skript ruft Werte aus Variablen ab, die aus Parameter-Elementen der FlowCallout-Richtlinie erstellt wurden.

   // 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. Die Ausführung fließt von der JavaScript-Richtlinie zurück zum freigegebenen Ablauf und dann zur FlowCallout-Richtlinie im ursprünglichen API-Proxy.

Syntax

Sie können dieses Element mit einem der folgenden Syntaxformen verwenden. Wenn Sie einen Literalwert verwenden, hängt das Format des angegebenen Werts vom Code ab, der ihn verwendet.

<!- 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>

Beispiel

Diese String-Handler FlowCallout-Richtlinie übergibt Parameter, mit denen festgelegt wird, wo die Ausgabe des freigegebenen Ablaufs gespeichert und welche Eingabe verwendet werden soll. Die Parameter Elemente geben die Namen und Werte der Variablen an, um die Laufzeit zu erstellen. Der freigegebene Ablauf kann diese Variablen zur Verwendung in ihrem eigenen Code abrufen.

<?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>

Syntax

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