Migrasi ke portal pengembang baru

  • Artikel

Artikel ini menjelaskan langkah-langkah yang perlu Anda ambil untuk bermigrasi dari portal warisan yang tidak digunakan lagi ke portal pengembang baru di API Management.

Penting

Portal pengembang warisan sekarang tidak digunakan lagi dan hanya akan menerima pembaruan keamanan. Anda dapat terus menggunakannya, seperti biasa, hingga masa pensiunnya pada bulan Oktober 2023, ketika portas tersebut akan dihapus dari semua layanan API Management.

Portal pengembang API Management

Ketersediaan

Penting

Fitur ini tersedia di tingkat Premium, Standar, Dasar, dan Pengembang API Management.

Untuk ketersediaan fitur di tingkat v2 (pratinjau), lihat gambaran umum tingkat v2.

Penyempurnaan di portal pengembang baru

Portal pengembang baru membahas banyak keterbatasan portal yang tidak digunakan lagi. Poral ini memiliki fitur editor seret dan jatuhkan visual untuk mengedit konten dan panel khusus bagi desainer untuk menata situs web. Halaman, kustomisasi, dan konfigurasi disimpan sebagai sumber daya Azure Resource Manager di layanan API Management Anda, yang memungkinkan Anda mengotomatiskan penyebaran portal. Terakhir, basis kode portal adalah sumber terbuka, sehingga Anda dapat memperluasnya dengan fungsionalitas kustom.

Cara bermigrasi ke portal pengembang baru

Portal pengembang baru tidak kompatibel dengan portal yang sudah tidak digunakan lagi dan migrasi otomatis tidak dimungkinkan. Anda harus membuat ulang konten secara manual (halaman, teks, file media) dan menyesuaikan tampilan portal baru. Langkah-langkah yang tepat akan berbeda-beda tergantung pada kustomisasi dan kompleksitas portal Anda. Lihat tutorial portal pengembang untuk panduan. Konfigurasi yang tersisa, seperti daftar API, produk, pengguna, penyedia identitas, secara otomatis akan dibagikan di kedua portal.

Penting

Jika Anda telah meluncurkan portal pengembang baru sebelumnya, namun Anda belum membuat perubahan apa pun, atur ulang konten default untuk memperbaruinya ke versi terbaru.

Saat Anda melakukan migrasi dari portal yang tidak digunakan lagi, ingatlah akan perubahan berikut:

  • Jika Anda mengekspos portal pengembang melalui domain kustom, tetapkan domain ke portal pengembang baru. Gunakan opsi Portal pengembang dari menu menurun di portal Microsoft Azure.

  • Terapkan kebijakan CORS pada API Anda untuk mengaktifkan konsol pengujian interaktif.

  • Jika Anda menyuntikkan CSS khusus untuk menata portal, Anda perlu mereplikasi gaya menggunakan panel desain bawaan. Suntikan CSS tidak diperbolehkan di portal baru.

  • Anda dapat menyuntikkan JavaScript kustom hanya di versi portal baru yang dihost sendiri.

  • Jika API Management Anda berada dalam jaringan virtual dan terpapar ke Internet melalui Application Gateway, lihat artikel dokumentasi ini untuk langkah-langkah konfigurasi yang tepat. Anda perlu:

    • Mengaktifkan konektivitas ke titik akhir manajemen API Management.
    • Mengaktifkan konektivitas ke titik akhir portal baru.
    • Menonaktifkan aturan Web Application Firewall yang dipilih.

  • Jika Anda mengubah templat pemberitahuan email default untuk menyertakan URL portal yang sudah tidak berlaku lagi yang ditentukan secara eksplisit, ubah templat tersebut untuk menggunakan parameter URL portal atau arahkan ke URL portal baru. Jika pola dasar menggunakan parameter URL portal bawaan, tidak ada perubahan yang diperlukan.

  • Masalah dan Aplikasi tidak didukung di portal pengembang baru.

  • Integrasi langsung dengan Facebook, Microsoft, Twitter, dan Google sebagai penyedia identitas tidak didukung di portal pengembang baru. Anda dapat mengintegrasikan dengan penyedia tersebut melalui Azure AD B2C.

  • Jika Anda menggunakan delegasi, ubah URL kembali di aplikasi Anda dan gunakan titik akhir Dapatkan Token Akses Bersama API alih-alih titik akhir Buat URL SSO.

  • Jika Anda menggunakan ID Microsoft Entra sebagai Penyedia Identitas:

    • Ubah URL pengembalian di aplikasi Anda untuk mengarahkan ke domain portal pengembang baru.
    • Ubah akhiran URL pengembalian di aplikasi Anda dari /signin-aad ke /signin.

  • Jika Anda menggunakan Azure AD B2C sebagai penyedia identitas:

    • Ubah URL pengembalian di aplikasi Anda untuk mengarahkan ke domain portal pengembang baru.
    • Ubah akhiran URL pengembalian di aplikasi Anda dari /signin-aad ke /signin.
    • Sertakan Nama Yang Diberikan, Nama Keluarga, dan ID Objek Pengguna dalam klaim aplikasi.

  • Jika Anda menggunakan OAuth 2.0 di konsol pengujian interaktif, ubah URL pengembalian di aplikasi Anda untuk mengarahkan ke domain portal pengembang baru dan memodifikasi akhiran:

    • Dari /docs/services/[serverName]/console/oauth2/authorizationcode/callback ke /signin-oauth/code/callback/[serverName] untuk aliran pemberian kode otorisasi.
    • Dari /docs/services/[serverName]/console/oauth2/implicit/callback ke /signin-oauth/implicit/callback untuk aliran pemberian implisit.

  • Jika Anda menggunakan OpenID Connect di konsol pengujian interaktif, ubah URL pengembalian di aplikasi Anda untuk mengarahkan ke domain portal pengembang baru dan memodifikasi akhiran:

    • Dari /docs/services/[serverName]/console/openidconnect/authorizationcode/callback ke /signin-oauth/code/callback/[serverName] untuk aliran pemberian kode otorisasi.
    • Dari /docs/services/[serverName]/console/openidconnect/implicit/callback ke /signin-oauth/implicit/callback untuk aliran pemberian implisit.

Langkah berikutnya

Pelajari selengkapnya tentang portal pengembang: