Korsdomänprinciper för API Management

Det här avsnittet innehåller en referens för följande API Management principer. Information om hur du lägger till och konfigurerar principer finns i Principer i API Management.

Principer mellan domäner

• Tillåt anrop mellan domäner – Gör API:et tillgängligt från Adobe Flash- och Microsoft Silverlight-webbläsarbaserade klienter.
• CORS – lägger till CORS-stöd (Cross-Origin Resource Sharing) för en åtgärd eller ett API för att tillåta anrop mellan domäner från webbläsarbaserade klienter.
• JSONP – Lägger till stöd för JSON med utfyllnad (JSONP) till en åtgärd eller ett API för att tillåta anrop mellan domäner från JavaScript-webbläsarbaserade klienter.

Tillåt anrop mellan domäner

Använd principen cross-domain för att göra API:et tillgängligt från Adobe Flash- och Microsoft Silverlight-webbläsarbaserade klienter.

Principutdrag

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

Exempel

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

Element

Användning

Den här principen kan användas i följande principavsnitt och omfång.

• Principavsnitt: inkommande
• Principomfång: alla omfång

CORS

Principen cors lägger till CORS-stöd (Cross-Origin Resource Sharing) för en åtgärd eller ett API för att tillåta anrop mellan domäner från webbläsarbaserade klienter.

CORS gör att en webbläsare och en server kan interagera och avgöra om specifika begäranden om korsande ursprung ska tillåtas (d.v.s. XMLHttpRequests-anrop som görs från JavaScript på en webbsida till andra domäner). Detta ger större flexibilitet än att bara tillåta begäranden om samma ursprung, men är säkrare än att tillåta alla begäranden om korsande ursprung.

Du måste tillämpa CORS-principen för att aktivera den interaktiva konsolen i utvecklarportalen. Mer information finns i dokumentationen för utvecklarportalen.

Principutdrag

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

Exempel

Det här exemplet visar hur du stöder begäranden före flygning,till exempel med anpassade huvuden eller metoder som inte är GET och POST. Om du vill ha stöd för anpassade huvuden och ytterligare HTTP-verb använder du allowed-methods allowed-headers avsnitten och som visas i följande exempel.

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

Element

Attribut

Användning

Den här principen kan användas i följande principavsnitt och omfång.

• Principavsnitt: inkommande
• Principomfång: alla omfång

JSONP

Principen lägger till stöd för JSON med utfyllnad (JSONP) till en åtgärd eller ett API för att tillåta anrop mellan domäner från jsonp JavaScript-webbläsarbaserade klienter. JSONP är en metod som används i JavaScript-program för att begära data från en server i en annan domän. JSONP kringgår den begränsning som tillämpas av de flesta webbläsare där åtkomsten till webbsidor måste finnas i samma domän.

Principsats

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

Exempel

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

Om du anropar metoden utan motringningsparametern ?cb=XXX returneras Oformaterad JSON (utan funktionsanropsomslutare).

Om du lägger till motringningsparametern returneras ett JSONP-resultat som omsluter de ursprungliga ?cb=XXX JSON-resultaten runt återanropsfunktionen som XYZ('<json result goes here>');

Element

Attribut

Användning

Den här principen kan användas i följande principavsnitt och omfång.

• Principavsnitt: utgående
• Principomfång: alla omfång

Nästa steg

Mer information om hur du arbetar med principer finns i:

• Principer i API Management
• Transformera API:er
• Principreferens för en fullständig lista över principutdrag och deras inställningar
• Principexempel