API Management-beleid voor meerdere domeinen

Dit onderwerp bevat een naslag voor de volgende API Management beleidsregels. Zie Beleidsregels in API Management voor meer informatie over het toevoegen en configureren API Management.

Beleid voor meerdere domeinen

• Aanroepen tussen domeinen toestaan: maakt de API toegankelijk via Adobe Flash- en Microsoft Silverlight-browsergebaseerde clients.
• CORS: voegt CORS-ondersteuning (Cross-Origin Resource Sharing) toe aan een bewerking of API om aanroepen tussen domeinen van browsergebaseerde clients toe te staan.
• JSONP: voegt ondersteuning voor JSON met opvulling (JSONP) toe aan een bewerking of api om aanroepen tussen domeinen toe te staan vanuit clients in de JavaScript-browser.

Aanroepen tussen domeinen toestaan

Gebruik het cross-domain beleid om de API toegankelijk te maken vanuit Adobe Flash- en Microsoft Silverlight-browser-clients.

Beleidsverklaring

<cross-domain>
    <!-Policy configuration is in the Adobe cross-domain policy file format,
        see https://www.adobe.com/devnet-docs/acrobatetk/tools/AppSec/CrossDomain_PolicyFile_Specification.pdf-->
</cross-domain>

Voorbeeld

<cross-domain>
        <allow-http-request-headers-from domain='*' headers='*' />
</cross-domain>

Elementen

Gebruik

Dit beleid kan worden gebruikt in de volgende beleidssecties en -scopes.

• Beleidssecties: inkomende
• Beleidsbereiken: alle scopes

CORS

Het cors beleid voegt ONDERSTEUNING voor cross-origin-resource delen (CORS) toe aan een bewerking of een API om aanroepen tussen domeinen toe te staan vanaf browsergebaseerde clients.

Met CORS kunnen een browser en een server communiceren en bepalen of specifieke cross-origin-aanvragen (dat wil zeggen XMLHttpRequests-aanroepen van JavaScript op een webpagina naar andere domeinen) zijn toegestaan. Dit biedt meer flexibiliteit dan alleen het toestaan van aanvragen van dezelfde oorsprong, maar is veiliger dan het toestaan van alle cross-origin-aanvragen.

U moet het CORS-beleid toepassen om de interactieve console in te kunnenschakelen in de ontwikkelaarsportal. Raadpleeg de documentatie voor de ontwikkelaarsportal voor meer informatie.

Beleidsverklaring

<cors allow-credentials="false|true" terminate-unmatched-request="true|false">
    <allowed-origins>
        <origin>origin uri</origin>
    </allowed-origins>
    <allowed-methods preflight-result-max-age="number of seconds">
        <method>http verb</method>
    </allowed-methods>
    <allowed-headers>
        <header>header name</header>
    </allowed-headers>
    <expose-headers>
        <header>header name</header>
    </expose-headers>
</cors>

Voorbeeld

In dit voorbeeld wordt gedemonstreerd hoe u aanvragen vóór de vluchtkunt ondersteunen, zoals aanvragen met aangepaste headers of andere methoden dan GET en POST. Als u aangepaste headers en aanvullende HTTP-woorden wilt ondersteunen, gebruikt u de allowed-methods secties en allowed-headers zoals wordt weergegeven in het volgende voorbeeld.

<cors allow-credentials="true">
    <allowed-origins>
        <!-- Localhost useful for development -->
        <origin>http://localhost:8080/</origin>
        <origin>http://example.com/</origin>
    </allowed-origins>
    <allowed-methods preflight-result-max-age="300">
        <method>GET</method>
        <method>POST</method>
        <method>PATCH</method>
        <method>DELETE</method>
    </allowed-methods>
    <allowed-headers>
        <!-- Examples below show Azure Mobile Services headers -->
        <header>x-zumo-installation-id</header>
        <header>x-zumo-application</header>
        <header>x-zumo-version</header>
        <header>x-zumo-auth</header>
        <header>content-type</header>
        <header>accept</header>
    </allowed-headers>
    <expose-headers>
        <!-- Examples below show Azure Mobile Services headers -->
        <header>x-zumo-installation-id</header>
        <header>x-zumo-application</header>
    </expose-headers>
</cors>

Elementen

Kenmerken

Gebruik

Dit beleid kan worden gebruikt in de volgende beleidssecties en -scopes.

• Beleidssecties: inkomende
• Beleidsbereiken: alle scopes

JSONP

Het beleid voegt JSON met ondersteuning voor opvulling (JSONP) toe aan een bewerking of een API om aanroepen tussen domeinen toe te staan vanaf clients in jsonp een JavaScript-browser. JSONP is een methode die wordt gebruikt in JavaScript-programma's om gegevens op te vragen bij een server in een ander domein. JSONP omzeilt de beperking die wordt afgedwongen door de meeste webbrowsers waarbij de toegang tot webpagina's in hetzelfde domein moet zijn.

Beleidsverklaring

<jsonp callback-parameter-name="callback function name" />

Voorbeeld

<jsonp callback-parameter-name="cb" />

Als u de methode aanroept zonder de callbackparameter ?cb=XXX, retourneert deze gewone JSON (zonder een wrapper voor functie-aanroepen).

Als u de callbackparameter toevoegt, retourneert deze een JSONP-resultaat, waardoor de oorspronkelijke JSON-resultaten rond de ?cb=XXX callback-functie worden verpakt, zoals XYZ('<json result goes here>');

Elementen

Kenmerken

Gebruik

Dit beleid kan worden gebruikt in de volgende beleidssecties en -scopes.

• Beleidssecties: uitgaand
• Beleidsbereiken: alle scopes

Volgende stappen

Zie voor meer informatie over het werken met beleidsregels:

• Beleid in API Management
• API's transformeren
• Beleidsverwijzing voor een volledige lijst met beleidsverklaringen en de instellingen
• Voorbeelden van beleid