Bagikan melalui

Mengonfigurasi pengelola kredensial - GITHub API

BERLAKU UNTUK: Semua tingkatan manajemen API

Dalam artikel ini, Anda mempelajari cara membuat koneksi terkelola di API Management dan memanggil API GitHub yang memerlukan token OAuth 2.0. Contoh ini menggunakan jenis pemberian kode otorisasi.

Anda akan mempelajari cara untuk:

  • Mendaftarkan aplikasi di GitHub
  • Mengonfigurasi penyedia kredensial di API Management
  • Konfigurasikan koneksi
  • Membuat API di API Management dan mengonfigurasi kebijakan
  • Menguji API GitHub Anda di API Management

Prasyarat

Langkah 1: Mendaftarkan aplikasi di GitHub

Buat aplikasi GitHub OAuth untuk API dan berikan izin yang sesuai untuk permintaan yang ingin Anda panggil.

  1. Masuk ke GitHub.

  2. Di profil akun Anda, buka Pengaturan > Pengaturan > Pengembang Aplikasi OAuth. Pilih Aplikasi OAuth baru.

    Cuplikan layar mendaftarkan aplikasi OAuth baru di GitHub.

    1. Masukkan Nama aplikasi dan URL Beranda untuk aplikasi. Untuk contoh ini, Anda dapat menyediakan URL tempat penampung seperti http://localhost.
    2. Secara opsional, tambahkan deskripsi Aplikasi.
    3. Di URL panggilan balik otorisasi (URL pengalihan), masukkan https://authorization-manager.consent.azure-apim.net/redirect/apim/<YOUR-APIM-SERVICENAME>, ganti nama instans API Management tempat Anda mengonfigurasi penyedia kredensial.
    4. Secara opsional pilih Aktifkan alur perangkat (tidak diperlukan untuk contoh ini).

  3. Pilih Daftarkan aplikasi.

  4. Pada halaman Umum , salin ID Klien, yang Anda gunakan di Langkah 2.

  5. Pilih Buat rahasia klien baru. Salin rahasia, yang tidak ditampilkan lagi. Anda mengonfigurasi rahasia di Langkah 2.

    Cuplikan layar memperlihatkan cara mendapatkan ID klien dan rahasia klien untuk aplikasi di GitHub.

Langkah 2: Mengonfigurasi penyedia kredensial di API Management

  1. Masuk ke portal Microsoft Azure dan buka instans API Management Anda.

  2. Di menu sebelah kiri, pilih API>Manajer Kredensial>+ Buat.

    Cuplikan layar pembuatan kredensial API Management di portal Microsoft Azure.

  3. Pada Buat penyedia kredensial, masukkan pengaturan berikut:

    Pengaturan Nilai
    Nama penyedia kredensial Nama pilihan Anda, seperti github-01
    Penyedia identitas Pilih GitHub
    Jenis pemberian Pilih Kode otorisasi
    ID Pelanggan Tempelkan nilai yang Anda salin sebelumnya dari pendaftaran aplikasi
    Rahasia klien Tempelkan nilai yang Anda salin sebelumnya dari pendaftaran aplikasi
    Scope Untuk contoh ini, atur cakupan ke Pengguna

  4. Pilih Buat.

  5. Saat diminta, tinjau URL pengalihan OAuth yang ditampilkan, dan pilih Ya untuk mengonfirmasi bahwa URL cocok dengan yang Anda masukkan di pendaftaran aplikasi GitHub.

Langkah 3: Mengonfigurasi koneksi

Pada tab Koneksi , selesaikan langkah-langkah untuk koneksi Anda ke penyedia.

Nota

Saat Anda mengonfigurasi koneksi, API Management secara default menyiapkan kebijakan akses yang memungkinkan akses oleh identitas terkelola yang ditetapkan sistem instans. Akses ini cukup untuk contoh ini. Anda dapat menambahkan kebijakan akses tambahan sesuai kebutuhan.

  1. Masukkan Nama koneksi, lalu pilih Simpan.
  2. Di bawah Langkah 2: Masuk ke koneksi Anda (untuk jenis pemberian kode otorisasi), pilih tombol Masuk . Selesaikan langkah-langkah dengan IdP Anda untuk mengotorisasi akses, dan kembali ke API Management.
  3. Di bawah Langkah 3: Tentukan siapa yang akan memiliki akses ke koneksi ini (Kebijakan akses), anggota identitas terkelola dicantumkan. Menambahkan anggota lain bersifat opsional, tergantung pada skenario Anda.
  4. Pilih Selesai.

Koneksi baru muncul dalam daftar koneksi, dan memperlihatkan status Tersambung. Jika Anda ingin membuat koneksi lain untuk penyedia kredensial, selesaikan langkah-langkah sebelumnya.

Petunjuk / Saran

Gunakan portal Microsoft Azure untuk menambahkan, memperbarui, atau menghapus koneksi ke penyedia kredensial kapan saja. Untuk informasi selengkapnya, lihat Mengonfigurasi beberapa koneksi.

Langkah 4: Membuat API di API Management dan mengonfigurasi kebijakan

  1. Masuk ke portal Microsoft Azure dan buka instans API Management Anda.

  2. Di menu sebelah kiri, pilih API API>>+ Tambahkan API.

  3. Pilih HTTP dan masukkan pengaturan berikut, lalu pilih Buat.

    Setting Nilai
    Nama tampilan githubuser
    URL layanan web https://api.github.com
    Akhiran URL API githubuser

  4. Buka API baru dan pilih Tambahkan Operasi. Masukkan pengaturan berikut dan pilih Simpan.

    Setting Nilai
    Nama tampilan getauthdata
    URL untuk GET /user

    Cuplikan layar menambahkan operasi getauthdata ke API di portal.

  5. Ikuti langkah-langkah sebelumnya untuk menambahkan operasi lain dengan pengaturan berikut.

    Setting Nilai
    Nama tampilan getauthfollowers
    URL untuk GET /user/pengikut

  6. Pilih Semua operasi. Di bagian Pemrosesan masuk , pilih ikon (</>) (editor kode).

  7. Salin dan tempel kode berikut di editor kebijakan. Pastikan nilai-nilai provider-id dan authorization-id dalam kebijakan get-authorization-context sesuai dengan nama kredensial penyedia dan koneksi, masing-masing, yang Anda konfigurasikan di langkah-langkah sebelumnya. Pilih Simpan.

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

Definisi kebijakan sebelumnya terdiri dari tiga bagian:

  • Kebijakan get-authorization-context mengambil token otorisasi dengan merujuk pada penyedia kredensial dan koneksi yang Anda buat sebelumnya.
  • Kebijakan set-header pertama membuat header HTTP dengan token otorisasi yang diambil.
  • Kebijakan set-header kedua membuat User-Agent header (persyaratan GITHub API).

Langkah 5: Uji API

  1. Pada tab Uji , pilih satu operasi yang Anda konfigurasi.

  2. Pilih Kirim.

    Cuplikan layar pengujian API berhasil di portal.

    Respons yang berhasil mengembalikan data pengguna dari GITHub API.

Konten terkait

  • Last updated on