Kimlik bilgisi yöneticisini yapılandırma - GitHub API'si

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, API Management'ta yönetilen bağlantı oluşturmayı ve OAuth 2.0 belirteci gerektiren bir GitHub API'sini çağırmayı öğreneceksiniz. Yetkilendirme kodu verme türü bu örnekte kullanılır.

Şunları yapmayı öğreneceksiniz:

Önkoşullar

• GitHub hesabı gereklidir.
• Çalışan bir API Management örneği. Gerekirse bir Azure API Management örneği oluşturun.
• API Management örneğinde API Management için sistem tarafından atanan yönetilen kimliği etkinleştirin.

1. Adım: GitHub'a uygulama kaydetme

API için bir GitHub OAuth uygulaması oluşturun ve çağırmak istediğiniz istekler için uygun izinleri verin.

1. GitHub'da oturum açma.

2. Hesap profilinizde Ayarlar Geliştirici Ayarlar > > OAuth Uygulamaları'na gidin. Yeni OAuth uygulaması'ni seçin.

   

   1. Uygulama için bir Uygulama adı ve Giriş Sayfası URL'si girin. Bu örnekte gibi http://localhostbir yer tutucu URL sağlayabilirsiniz.
   2. İsteğe bağlı olarak bir Uygulama açıklaması ekleyin.
   3. Yetkilendirme geri çağırma URL'si (yeniden yönlendirme URL'si ) https://authorization-manager.consent.azure-apim.net/redirect/apim/<YOUR-APIM-SERVICENAME>alanına, kimlik bilgisi sağlayıcısını yapılandıracağınız API Management örneğinin adını girin.

3. Uygulamayı kaydet'i seçin.

4. Genel sayfasında, 2. Adımda kullanacağınız İstemci Kimliğini kopyalayın.

5. Yeni bir istemci gizli dizisi oluştur'a tıklayın. Bir daha görüntülenmeyecek olan ve 2. Adımda kullanacağınız gizli diziyi kopyalayın.

   

2. Adım: API Management'ta kimlik bilgisi sağlayıcısı yapılandırma

1. Portalda oturum açın ve API Management örneğine gidin.

2. Sol menüde Kimlik bilgisi yöneticisi>+ Oluştur'u seçin.

   

3. Kimlik bilgisi sağlayıcısı oluştur sayfasında aşağıdaki ayarları girin:

   Ayarlar	Değer
   Kimlik bilgisi sağlayıcısı adı	Github-01 gibi seçtiğiniz bir ad
   Kimlik sağlayıcısı	GitHub'ı seçin
   Verme türü	Yetkilendirme kodunu seçin
   İstemci kimliği	Uygulama kaydından daha önce kopyaladığınız değeri yapıştırın
   İstemci gizli anahtarı	Uygulama kaydından daha önce kopyaladığınız değeri yapıştırın
   Scope	Bu örnek için kapsamı Kullanıcı olarak ayarlayın

4. Oluştur'u belirleyin.

5. İstendiğinde, görüntülenen OAuth yeniden yönlendirme URL'sini gözden geçirin ve uygulama kaydına girdiğiniz URL ile eşleşip eşleşmediğini onaylamak için Evet'i seçin.

3. Adım: Bağlantı yapılandırma

Bağlan sekmesinde, sağlayıcıyla bağlantınızın adımlarını tamamlayın.

1. bir Bağlan ion adı girin ve Kaydet'i seçin.
2. 2. Adım: Bağlantınızda oturum açın (yetkilendirme kodu verme türü için) altında, kimlik bilgisi sağlayıcısında oturum açmak için bağlantıyı seçin. Erişimi yetkilendirmek ve API Management'a dönmek için buradaki adımları tamamlayın.
3. 3. Adım: Bu bağlantıya kimlerin erişeceğini belirleme (Erişim ilkesi) altında, yönetilen kimlik üyesi listelenir. Senaryonuza bağlı olarak diğer üyeleri eklemek isteğe bağlıdır.
4. Tamamla’yı seçin.

Yeni bağlantı, bağlantılar listesinde görünür ve Bağlan durumunu gösterir. Kimlik bilgisi sağlayıcısı için başka bir bağlantı oluşturmak istiyorsanız, önceki adımları tamamlayın.

4. Adım: API Management'ta API oluşturma ve ilke yapılandırma

1. Portalda oturum açın ve API Management örneğine gidin.

2. Sol menüde API'ler > + API Ekle'yi seçin.

3. HTTP'yi seçin ve aşağıdaki ayarları girin. Daha sonra, Oluştur'u seçin.

   Ayar	Value
   Görünen ad	githubuser
   Web hizmeti URL'si	https://api.github.com
   API URL’si soneki	githubuser

4. Yeni oluşturulan API'ye gidin ve İşlem Ekle'yi seçin. Aşağıdaki ayarları girin ve Kaydet'i seçin.

   Ayar	Value
   Görünen ad	getauthdata
   GET URL'si	/kullanıcı

   

5. Aşağıdaki ayarlarla başka bir işlem eklemek için önceki adımları izleyin.

   Ayar	Value
   Görünen ad	getauthfollowers
   GET URL'si	/user/takipçiler

6. Tüm işlemler’i seçin. Gelen işleme bölümünde (/>) (<kod düzenleyicisi) simgesini seçin.

7. Aşağıdakileri kopyalayın ve ilke düzenleyicisine yapıştırın. İlkedeki ve authorization-id değerlerinin provider-id get-authorization-context, önceki adımlarda yapılandırdığınız kimlik bilgisi sağlayıcısının ve bağlantının adlarına karşılık olduğundan emin olun. Kaydet'i seçin.

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

Yukarıdaki ilke tanımı üç bölümden oluşur:

• get-authorization-context ilkesi, daha önce oluşturduğunuz kimlik bilgisi sağlayıcısına ve bağlantıya başvurarak bir yetkilendirme belirteci getirir.
• İlk set-header ilkesi, getirilen yetkilendirme belirteciyle bir HTTP üst bilgisi oluşturur.
• İkinci üst bilgi kümesi ilkesi bir User-Agent üst bilgi oluşturur (GitHub API gereksinimi).

5. Adım: API'yi test edin

1. Test sekmesinde, yapılandırdığınız bir işlemi seçin.

2. Gönder'i seçin.

   

   Başarılı bir yanıt GitHub API'sinden kullanıcı verilerini döndürür.

İlgili içerik

• Kimlik doğrulama ve yetkilendirme ilkeleri hakkında daha fazla bilgi edinin
• GitHub'ın REST API'si hakkında daha fazla bilgi edinin