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

PLATÍ PRO: Všechny úrovně služby API Management

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.

Získáte informace pro:

Požadavky

• Vyžaduje se účet GitHubu.
• Spuštěná instance služby API Management. Pokud potřebujete, vytvořte instanci služby Azure API Management.
• Povolte spravovanou identitu přiřazenou systémem pro službu API Management v instanci služby API Management.

Krok 1: Registrace aplikace na GitHubu

Vytvořte aplikaci GitHub OAuth pro rozhraní API a udělte jí příslušná oprávnění pro požadavky, které chcete volat.

1. Přihlaste se na GitHub.

2. Ve svém profilu účtu přejděte na Nastavení > Developer Nastavení > OAuth Apps. Vyberte novou aplikaci OAuth.

   

   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>název instance služby API Management, kde nakonfigurujete zprostředkovatele 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.

   

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

1. Přihlaste se k portálu a přejděte do instance služby API Management.

2. V nabídce vlevo vyberte Správce> přihlašovacích údajů + Vytvořit.

   

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
   Zprostředkovatel 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 Hodnotu 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í ion proveďte kroky pro připojení k poskytovateli.

1. Zadejte název Připojení ion 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 odkaz pro přihlášení k poskytovateli přihlašovacích údajů. Proveďte tam kroky pro autorizaci přístupu a vraťte se do služby API Management.
3. V kroku 3: Určete, kdo bude mít k tomuto připojení přístup (zásady přístupu) uvedený člen spravované identity. Přidání dalších členů je volitelné v závislosti na vašem scénáři.
4. Zvolte Dokončit.

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

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

1. Přihlaste se k portálu a přejděte do instance služby API Management.

2. V nabídce vlevo vyberte rozhraní API > a přidat rozhraní API.

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

   Nastavení	Hodnota
   Zobrazované jméno	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.

   Nastavení	Hodnota
   Zobrazované jméno	getauthdata
   Adresa URL pro GET	/user

   

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

   Nastavení	Hodnota
   Zobrazované jméno	getauthfollowers
   Adresa URL pro GET	/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 následující text a vložte ho do editoru zásad. Ujistěte se provider-id , že hodnoty a authorization-id hodnoty v get-authorization-context zásadách odpovídají názvům zprostředkovatele přihlašovacích údajů a připojení, které jste nakonfigurovali v předchozích krocích. Zvolte 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í zásada hlavičky set vytvoří hlavičku HTTP s načteným autorizačním tokenem.
• Druhá zásada hlavičky sady vytvoří hlavičku User-Agent (požadavek rozhraní API GitHubu).

Krok 5: Testování rozhraní API

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

2. Vyberte Odeslat.

   

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

Související obsah

• Další informace o zásadách ověřování a autorizace
• Další informace o rozhraní REST API GitHubu