Sdílet prostřednictvím

Konfigurace správce přihlašovacích údajů – rozhraní API GitHubu

PLATÍ PRO: Všechny úrovně služby správy rozhraní API

V tomto článku se dozvíte, jak vytvořit spravované připojení ve službě API Management a volat rozhraní API GitHubu, které vyžaduje token OAuth 2.0. V tomto příkladu se používá typ udělení autorizačního kódu.

Naučíte se:

  • Registrace aplikace na GitHubu
  • Konfigurace zprostředkovatele přihlašovacích údajů ve službě API Management
  • Konfigurace připojení
  • Vytvoření rozhraní API ve službě API Management a konfigurace zásad
  • Testování rozhraní API GitHubu ve službě API Management

Požadavky

Krok 1: Registrace aplikace na GitHubu

Vytvořte aplikaci GitHub OAuth pro použití s rozhraním API a udělte jí příslušná oprávnění k požadovaným operacím.

  1. Přihlaste se k GitHubu.

  2. Ve svém profilu účtu přejděte do Nastavení > Nastavení vývojáře > OAuth Apps. Vyberte Nová aplikace OAuth.

    Snímek obrazovky s registrací nové aplikace OAuth na GitHubu

    1. Zadejte název aplikace a adresu URL domovské stránky aplikace. V tomto příkladu můžete zadat zástupnou adresu URL, například http://localhost.
    2. Volitelně můžete přidat popis aplikace.
    3. Do adresy URL zpětného volání autorizace (adresa URL pro přesměrování) zadejte https://authorization-manager.consent.azure-apim.net/redirect/apim/<YOUR-APIM-SERVICENAME> s názvem instance API Management, kde nakonfigurujete poskytovatele přihlašovacích údajů.

  3. Vyberte Zaregistrovat aplikaci.

  4. Na stránce Obecné zkopírujte ID klienta, které použijete v kroku 2.

  5. Vyberte Vygenerovat nový tajný klíč klienta. Zkopírujte tajný kód, který se znovu nezobrazí a který použijete v kroku 2.

    Snímek obrazovky znázorňující, jak získat ID klienta a tajný klíč klienta pro aplikaci na GitHubu

Krok 2: Konfigurace zprostředkovatele přihlašovacích údajů ve službě API Management

  1. Přihlaste se k webu Azure Portal a přejděte do instance služby API Management.

  2. Na levém menu vyberte rozhraní API>Správce přihlašovacích údajů>+ Vytvořit.

    Snímek obrazovky s vytvářením přihlašovacích údajů služby API Management na webu Azure Portal

  3. Na stránce Vytvořit zprostředkovatele přihlašovacích údajů zadejte následující nastavení:

    Nastavení Hodnota
    Název zprostředkovatele přihlašovacích údajů Název podle vašeho výběru, například github-01
    Poskytovatel identity Výběr GitHubu
    Typ udělení Výběr autorizačního kódu
    ID klienta Vložte hodnotu, kterou jste zkopírovali dříve z registrace aplikace.
    Tajný klíč klienta Vložte hodnotu, kterou jste zkopírovali dříve z registrace aplikace.
    Scope V tomto příkladu nastavte obor na Uživatel.

  4. Vyberte Vytvořit.

  5. Po zobrazení výzvy zkontrolujte adresu URL přesměrování OAuth, která se zobrazí, a výběrem možnosti Ano potvrďte, že odpovídá adrese URL, kterou jste zadali v registraci aplikace.

Krok 3: Konfigurace připojení

Na kartě Připojení proveďte kroky pro připojení k poskytovateli.

Poznámka:

Když nakonfigurujete připojení, služba API Management ve výchozím nastavení nastaví zásady přístupu , které umožňují přístup spravované identitě přiřazené systémem instance. Tento přístup pro tento příklad stačí. Podle potřeby můžete přidat další zásady přístupu.

  1. Zadejte název připojení a pak vyberte Uložit.
  2. V části Krok 2: Přihlaste se ke svému připojení (pro typ udělení autorizačního kódu) vyberte tlačítko Přihlásit se. Proveďte tam kroky pro autorizaci přístupu a vraťte se do služby API Management.
  3. Ve 3. kroku: Určete, kdo bude mít k tomuto připojení přístup (přístupové zásady) je uveden člen spravované identity. Přidání dalších členů je volitelné v závislosti na vašem scénáři.
  4. Vyberte Dokončit.

Nové připojení se zobrazí v seznamu připojení a zobrazuje stav Připojeno. Pokud chcete pro zprostředkovatele přihlašovacích údajů vytvořit další připojení, proveďte předchozí kroky.

Návod

Připojení k poskytovateli přihlašovacích údajů můžete kdykoli přidat, aktualizovat nebo odstranit pomocí webu Azure Portal. Další informace najdete v tématu Konfigurace více připojení.

Krok 4: Vytvoření rozhraní API ve službě API Management a konfigurace zásad

  1. Přihlaste se k webu Azure Portal a přejděte do instance služby API Management.

  2. V nabídce vlevo vyberte rozhraní API>>+ Přidat rozhraní API.

  3. Vyberte HTTP a zadejte následující nastavení a pak vyberte Vytvořit.

    Setting Hodnota
    Zobrazovaný název githubuser
    Adresa URL webové služby https://api.github.com
    Přípona adresy URL rozhraní API githubuser

  4. Přejděte do nově vytvořeného rozhraní API a vyberte Přidat operaci. Zadejte následující nastavení a vyberte Uložit.

    Setting Hodnota
    Zobrazovaný název getauthdata
    URL pro GET požadavek /user

    Snímek obrazovky s přidáním operace getauthdata do rozhraní API na portálu

  5. Podle předchozích kroků přidejte další operaci s následujícím nastavením.

    Setting Hodnota
    Zobrazovaný název getauthfollowers
    URL pro GET požadavek /uživatel/sledující

  6. Vyberte Všechny operace. V části Zpracování příchozích dat vyberte ikonu (</>) (editor kódu).

  7. Zkopírujte a vložte následující text v editoru zásad. Ujistěte se, že hodnoty provider-id a authorization-id v zásadách get-authorization-context odpovídají názvům zprostředkovatele přihlašovacích údajů a připojení, které jste nakonfigurovali v předchozích krocích. Vyberte Uložit.

    <policies>
    <inbound>
        <base />
        <get-authorization-context provider-id="github-01" authorization-id="first-connection" context-variable-name="auth-context" identity-type="managed" ignore-error="false" />
        <set-header name="Authorization" exists-action="override">
            <value>@("Bearer " + ((Authorization)context.Variables.GetValueOrDefault("auth-context"))?.AccessToken)</value>
        </set-header>
        <set-header name="User-Agent" exists-action="override">
            <value>API Management</value>
        </set-header>
    </inbound>
    <backend>
        <base />
    </backend>
    <outbound>
        <base />
    </outbound>
    <on-error>
        <base />
    </on-error>
</policies>

Předchozí definice zásady se skládá ze tří částí:

  • Zásada get-authorization-context načte autorizační token odkazováním na zprostředkovatele přihlašovacích údajů a připojení, které jste vytvořili dříve.
  • První pravidlo set-header vytvoří hlavičku HTTP, která obsahuje načtený autorizační token.
  • Druhá zásada set-header vytvoří User-Agent hlavičku (požadavek GitHub API).

Krok 5: Testování rozhraní API

  1. Na kartě Test vyberte jednu operaci, kterou jste nakonfigurovali.

  2. Vyberte Odeslat.

    Snímek obrazovky s úspěšným testováním rozhraní API na portálu

    Úspěšná odpověď vrátí uživatelská data z rozhraní API GitHubu.

Související obsah

  • Last updated on