Cara pengguna portal berinteraksi dengan portal Anda

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Siap pakai, portal developer memungkinkan pengguna portal Anda membuat akun pengguna, login, dan mengelola aplikasi yang akan menggunakan API Anda.

Bagian berikut menjelaskan cara pengguna portal berinteraksi dengan portal Anda.

Login ke portal

Bagian berikut menjelaskan cara pengguna portal login ke portal terintegrasi menggunakan kredensial pengguna (penyedia identitas bawaan) atau menggunakan SAML (Beta).

Jika Anda mengaktifkan penyedia identitas bawaan dan SAML, pengguna portal akan dapat memilih metode login pilihan mereka.

Login ke portal menggunakan kredensial pengguna (penyedia identitas bawaan)

Catatan: Halaman login tidak dapat diedit selain untuk mengubah logo perusahaan seperti yang dijelaskan dalam Mengonfigurasi pembuatan akun pengguna dan pengalaman login.

Jika penyedia identitas bawaan diaktifkan, pengguna portal dapat login ke portal terintegrasi menggunakan kredensial pengguna mereka (nama pengguna dan sandi), seperti yang dijelaskan di bagian berikut:

• Buat akun pengguna di portal terintegrasi
• Login ke portal terintegrasi
• Mengubah sandi

Membuat akun pengguna di portal terintegrasi

Dengan penyedia identitas bawaan, pengguna portal harus membuat akun pengguna di portal terintegrasi sebelum dapat menggunakan API Anda.

Poin penting: Lihat juga Tempat informasi akun developer aplikasi disimpan.

Meskipun memungkinkan untuk membuat akun pengguna atas nama pengguna portal secara manual menggunakan UI pengelolaan Edge, seperti yang dijelaskan dalam Mendaftarkan developer aplikasi, hal ini tidak direkomendasikan untuk memastikan bahwa akun pengguna di portal terintegrasi dan catatan developer di Edge tetap sinkron.

Pengguna portal membuat akun di portal terintegrasi sebagai berikut:

1. Buka portal.

2. Klik Sign In.

   Halaman Login akan ditampilkan.

3. Klik Buat Akun.

   Halaman Buat akun Anda akan ditampilkan.

   

   Catatan: Anda dapat menambahkan kolom pendaftaran kustom ke halaman pembuatan akun, seperti yang dijelaskan dalam Menambahkan kolom pendaftaran kustom ke halaman pembuatan akun.

4. Isi formulir.

   Anda harus memasukkan nilai untuk semua kolom wajib. Kata sandi minimal harus terdiri dari 8 karakter dan berisi minimal salah satu dari setiap hal berikut: angka, huruf kecil, huruf besar, dan karakter khusus.

5. Tinjau dan setujui persyaratan.

6. Klik Create Account.
   

   Catatan:Jika ada upaya untuk membuat akun dengan ID email yang sudah terdaftar, pesan yang menunjukkan bahwa akun tersebut sudah ada akan ditampilkan, dan pengguna portal akan disarankan untuk login.
   1. Lengkapi formulir CAPTCHA, lalu klik Verifikasi (jika ditampilkan).

   Akun pengguna dibuat dan email konfirmasi akan dikirim.

   Catatan: Anda dapat mengonfigurasi email konfirmasi, seperti yang dijelaskan dalam Mengonfigurasi notifikasi email. Apigee merekomendasikan agar Anda mengonfigurasi server SMTP yang digunakan untuk notifikasi email yang berasal dari portal sebelum diluncurkan, seperti yang dijelaskan dalam Mengonfigurasi server SMTP.

7. Dalam waktu 10 menit, klik link di email konfirmasi untuk menyelesaikan proses pendaftaran.

   Jika tautan tidak diklik dalam waktu 10 menit, Anda harus mengulangi langkah-langkah dalam prosedur ini untuk membuat akun dan diminta kembali.

8. Login ke portal terintegrasi (dijelaskan di bawah).

Login ke portal terintegrasi

Dengan penyedia identitas bawaan, setelah pengguna portal mendaftar di portal terintegrasi dan disetujui, mereka akan login menggunakan kredensial mereka (nama pengguna dan sandi).

Catatan:

• Setelah 24 jam tidak aktif, sesi akan berakhir, dan pengguna portal akan otomatis logout serta harus login lagi.
• Jika mengonfigurasi portal terintegrasi agar mewajibkan aktivasi akun pengguna secara manual, Anda harus mengaktifkan akun pengguna secara manual sebelum pengguna portal dapat login. Saat ini, pengguna portal tidak diberi indikasi bahwa pendaftaran mereka harus diaktifkan secara manual sebelum dapat login. Sebaiknya, jika Anda mengonfigurasi aktivasi manual, Anda akan mempercepat aktivasi akun pengguna baru.
• Untuk membuka halaman Login secara langsung, gunakan URL berikut:
  https://portal-url/login

Pengguna portal login sebagai berikut:

1. Buka portal.
2. Klik Sign In.
   Halaman Login akan menampilkan:
   
3. Masukkan alamat email dan sandi.
4. Klik Sign In.

Mengubah {i>password<i}

Dengan penyedia identitas bawaan, pengguna portal mengubah sandi sebagai berikut:

1. Buka portal.
2. Klik Sign In.
3. Klik Setel Ulang Sandi.
4. Masukkan alamat email untuk akun yang akan direset.

5. Klik Kirim Link Reset Sandi.

   Link reset sandi dikirim ke email tersebut.

   Catatan: Untuk mengonfigurasi server SMTP, lihat Mengonfigurasi server SMTP.

6. Klik link di email konfirmasi.

7. Masukkan sandi baru dan konfirmasi.

   Kata sandi minimal harus terdiri dari 8 karakter dan berisi minimal salah satu dari setiap hal berikut: angka, huruf kecil, huruf besar, dan karakter khusus.

8. Klik Buat Sandi Baru.

Login ke portal menggunakan autentikasi SAML (Beta)

Catatan: Ini adalah rilis Beta penyedia identitas SAML.

Catatan: Halaman login tidak dapat diedit selain untuk mengubah logo perusahaan seperti yang dijelaskan dalam Mengonfigurasi pembuatan akun pengguna dan pengalaman login.

Saat Penyedia identitas SAML diaktifkan, pengguna portal akan login ke portal terintegrasi menggunakan autentikasi SAML, sebagai berikut:

1. Buka portal.
2. Klik Sign In.

3. Klik login with SAML.

   Anda akan dialihkan ke penyedia SAML.

4. Jika diminta, masukkan kredensial untuk penyedia identitas SAML.

Catatan: Setelah 24 jam tidak aktif, sesi akan berakhir, dan pengguna portal akan otomatis logout serta harus login lagi.

Melihat dokumentasi referensi API

Pengguna portal dapat melihat dokumentasi referensi API yang telah Anda publikasikan ke portal, sebagai berikut:

1. Buka portal.

2. Klik API di menu navigasi atas.
   Halaman API akan ditampilkan. Contoh:
   
   

3. Memfilter daftar API berdasarkan kategori, judul, atau deskripsi, jika diinginkan, menggunakan alat di panel kiri.

4. Klik kartu API untuk melihat dokumentasi referensi API.
   Dokumentasi referensi API akan ditampilkan.

Pengguna portal dapat mempelajari dan mencoba API, atau mendownload dokumen yang digunakan untuk merender dokumentasi referensi API. Lihat Memublikasikan API untuk informasi selengkapnya tentang cara dokumentasi referensi API dirender.

Berbagi tanggung jawab untuk aplikasi menggunakan tim developer (beta)

Catatan: Anda harus terdaftar dalam rilis beta fitur tim.

Tim developer memungkinkan pengguna portal untuk berbagi tanggung jawab atas aplikasi dengan pengguna portal lainnya. Bagian berikut menjelaskan cara membuat dan mengelola tim developer.

Poin penting: Tim developer disebut hanya sebagai "tim" saat menjelajahi portal developer.

Tentang peran tim developer

Tabel berikut meringkas peran yang dapat ditetapkan kepada anggota tim developer:

Catatan: Sebagai anggota tim developer, Anda dapat menghapus diri sendiri dari tim developer mana pun, apa pun peran Anda, kecuali jika Anda adalah pemilik tim developer.

Peran	Deskripsi
Admin Aplikasi	Hak istimewa hanya baca untuk anggota tim developer dan detail tim developer. Hak istimewa membaca dan menulis untuk aplikasi.
Pemilik	Hak istimewa baca dan tulis penuh untuk anggota tim developer, detail tim developer, dan aplikasi.
Pelihat	Hak istimewa hanya baca untuk anggota tim developer, detail tim developer, dan aplikasi.

Melihat halaman Teams

Halaman Teams menampilkan tim developer tempat Anda menjadi anggota.

Untuk mengakses halaman Tim:

1. Login ke portal.
2. Pilih Teams dari drop-down akun pengguna di portal.

Halaman Teams akan ditampilkan yang memungkinkan Anda untuk:

• Melihat tim developer tempat Anda menjadi anggota, termasuk nama, peran, daftar anggota, dan tanggal tim tersebut dibuat
• Menambahkan tim developer
• Edit keanggotaan dan peran tim developer, hapus diri Anda dari tim developer, atau hapus tim dengan mengklik baris tim developer

Menambahkan tim developer

Catatan: Pengguna portal dapat melihat tim developer tempat mereka menjadi anggota di halaman Tim. Untuk rilis beta, tidak ada notifikasi yang dikirim saat pengguna portal ditambahkan ke tim developer.

Untuk menambahkan tim developer:

1. Login ke portal.
2. Pilih Teams dari drop-down akun pengguna di portal.
3. Klik + Tim Baru.
4. Masukkan nama dan deskripsi.

5. Untuk menambahkan anggota ke tim developer, klik + Tambahkan anggota lain, masukkan alamat email pengguna portal, lalu pilih peran tim developer.

   Ulangi untuk menambahkan anggota lain.

   Catatan:

   • Anda akan otomatis ditambahkan sebagai pemilik tim developer.
   • Jumlah maksimum tim developer tempat pengguna dapat menjadi anggota adalah 16.

6. Untuk menghapus anggota dari tim developer, klik di samping anggota tim developer yang ingin Anda hapus.

7. Klik Create.

Mengedit keanggotaan dan peran tim developer

Untuk mengedit keanggotaan dan peran tim developer:

1. Login ke portal.
2. Pilih Teams dari drop-down akun pengguna di portal.
3. Klik baris tim developer yang ingin Anda edit dan tempat Anda menjadi pemiliknya.

4. Lakukan satu atau beberapa langkah berikut:

   • Edit nama, deskripsi, dan kontak utama.
   • Menambahkan atau menghapus anggota tim developer.
   • Memperbarui peran anggota tim developer.
     Catatan:

     • Tim developer harus memiliki minimal satu pemilik.
     • Jumlah maksimum tim developer tempat pengguna dapat menjadi anggota adalah 16.

5. Klik Simpan.

Menghapus diri Anda dari tim developer

Catatan: Sebagai anggota tim developer, Anda dapat menghapus diri sendiri dari tim developer mana pun, terlepas dari peran tim developer kecuali jika Anda adalah pemilik tim developer.

Untuk menghapus diri Anda dari tim developer:

1. Login ke portal.
2. Pilih Teams dari drop-down akun pengguna di portal.
3. Klik di baris tim developer yang ingin Anda hapus diri Anda.
4. Klik Keluar dari Tim.

Menghapus tim developer

Catatan: Jika Anda menghapus tim developer, semua aplikasi yang dimiliki oleh tim developer akan dihapus.

Untuk menghapus tim developer:

1. Login ke portal.
2. Pilih Teams dari drop-down akun pengguna di portal.
3. Klik baris tim developer yang ingin dihapus.
4. Klik .
5. Klik Konfirmasi untuk mengonfirmasi penghapusan.

Mendaftarkan aplikasi

Daftarkan aplikasi developer dan aplikasi tim developer, seperti yang dijelaskan di bagian berikut.

Mendaftarkan aplikasi developer

Poin penting: Setelah pengguna portal mendaftarkan aplikasi developer, informasi akun pengguna akan disinkronkan dan tersedia di Edge pada halaman Developer. Lihat Tempat informasi akun developer aplikasi disimpan.

Pengguna portal dapat mendaftarkan aplikasi untuk menggunakan API yang telah Anda publikasikan, sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik + Aplikasi Baru untuk membuat aplikasi baru.
3. Masukkan nama dan deskripsi untuk aplikasi dalam dialog Aplikasi Baru.

4. Di bagian Katalog API, pilih satu atau beberapa API.

   API dalam katalog dikategorikan sebagai API Terautentikasi, memerlukan URL callback, atau API Publik. Anda harus memilih setidaknya satu API untuk membuat aplikasi.

5. Jika Anda memilih API di bagian Authenticated APIs, masukkan URL callback.

   Untuk informasi selengkapnya, lihat artikel Tentang URL callback.

6. Klik Create.

Mendaftarkan aplikasi tim developer

Catatan: Langkah ini hanya berlaku jika Anda telah terdaftar dalam rilis beta fitur tim. Dalam versi beta, kepemilikan aplikasi tidak dapat ditransfer setelah aplikasi dibuat.

Anggota tim developer dapat mendaftarkan aplikasi agar tim developer dapat menggunakan API yang telah Anda publikasikan, seperti yang dijelaskan di bawah.

Catatan: Entitas tim developer baru akan ditambahkan ke Edge hanya setelah anggota mendaftarkan aplikasi untuk tim tersebut. Lihat Tempat informasi tim developer disimpan (beta).

Untuk mempelajari lebih lanjut cara:

• Pengguna portal menambahkan dan mengelola tim, seperti yang dijelaskan dalam Berbagi tanggung jawab untuk aplikasi menggunakan tim developer (beta).
• Penyedia API melihat dan mengelola tim developer, seperti yang dijelaskan dalam Mengelola tim developer (beta).

Untuk mendaftarkan aplikasi tim developer:

1. Pilih Teams dari drop-down akun pengguna.
2. Klik baris tim developer tempat Anda ingin mendaftarkan aplikasi.
3. Klik + Aplikasi Baru untuk membuat aplikasi baru.
4. Masukkan nama dan deskripsi untuk aplikasi dalam dialog Aplikasi Baru.

5. Pilih pemilik Aplikasi di menu drop-down Pemilik.

   Secara default, tim developer adalah pemilik aplikasi. Jika ingin, pilih tim developer lain atau diri Anda sendiri sebagai pemilik dari menu drop-down.

   Catatan: Dalam rilis beta, kepemilikan aplikasi tidak dapat ditransfer setelah aplikasi dibuat.

6. Di bagian Katalog API, pilih satu atau beberapa API.

   API dalam katalog dikategorikan sebagai API Terautentikasi, memerlukan URL callback, atau API Publik. Anda harus memilih setidaknya satu API untuk membuat aplikasi.

7. Jika Anda memilih API di bagian Authenticated APIs, masukkan URL callback.

   Untuk informasi selengkapnya, lihat artikel Tentang URL callback.

8. Klik Create.

Mengelola API dalam aplikasi

Sebagai produsen API, Anda dapat memublikasikan API agar pengguna portal dapat menggunakan produk API Anda.

Pengguna portal mengelola API mana yang digunakan aplikasi mereka. API tersebut ditambahkan ke halaman detail aplikasi. Untuk sebagian API, persetujuan tidak bersifat otomatis. Status Menunggu Persetujuan menunjukkan API yang aksesnya telah diminta tetapi belum diberikan.

Catatan: API yang tidak dipublikasikan tidak ditampilkan untuk saat ini; masalah ini akan diperbaiki dalam rilis mendatang.

Jika pengguna portal menonaktifkan akses ke API yang bersifat Pribadi atau Khusus Internal, API tersebut akan dihapus dari aplikasi dan harus ditambahkan kembali secara manual oleh administrator portal, seperti yang dijelaskan di Kontrol akses ke API Anda dengan mendaftarkan aplikasi.

Pengguna portal dapat mengelola API di aplikasi dari portal Anda, sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik aplikasi dalam daftar.
3. Di bagian API, klik atau untuk mengaktifkan atau menonaktifkan akses masing-masing ke API dari aplikasi.
4. Untuk API yang Diautentikasi, tambahkan atau edit URL callback, sesuai kebutuhan.

Melihat kunci API dan rahasia untuk aplikasi

Pengguna portal dapat mengelola kunci API untuk aplikasi dari portal Anda, sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik aplikasi dalam daftar.
3. Lihat kunci API di bagian Kunci API.
4. Pastikan status kunci API Active.
   Jika kunci API memerlukan persetujuan dan belum disetujui, statusnya akan ditampilkan sebagai Menunggu Persetujuan.
5. Klik Show secret untuk melihat rahasia.
6. Posisikan kursor di atas kunci API atau secret, lalu klik untuk menyalinnya ke papan klip.

Catatan: Jika akun pengguna atau aplikasi telah dinonaktifkan/dicabut, kunci API tidak akan valid hingga akun pengguna atau aplikasi diaktifkan kembali/disetujui kembali. Untuk informasi selengkapnya, lihat Mengaktifkan dan menonaktifkan developer dan Menyetujui atau mencabut aplikasi.

Memutar kunci API untuk aplikasi

Pengguna portal dapat merotasi kunci API aplikasi secara berkala atau sebagai respons terhadap potensi kebocoran atau penyusupan. Saat pengguna portal merotasi kunci API, kunci API baru dibuat dengan hak API yang sama seperti kunci asli. Kunci API asli tetap aktif saat Anda mentransisikannya dari penggunaan. Anda harus mencabut kunci API lama agar kredensialnya tidak diterima, seperti yang dijelaskan dalam Mencabut kunci API untuk aplikasi.

Pengguna portal dapat merotasi kunci API untuk aplikasi dari portal Anda, sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik aplikasi dalam daftar.
3. Di bagian Kunci API, klik Add Key.
4. Klik Confirm di kotak dialog untuk mengonfirmasi operasi.
5. Opsional, cabut kunci API lama, seperti yang dijelaskan di bawah.

Mencabut kunci API untuk aplikasi

Saat pengguna portal merotasi kunci API, seperti yang dijelaskan di bagian sebelumnya, kunci API tersebut akan tetap aktif saat Anda mentransisikan kunci API tersebut dari penggunaan. Anda harus mencabut kunci API agar kredensialnya tidak diterima.

Pengguna portal dapat mencabut kunci API untuk aplikasi dari portal Anda, sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik nama aplikasi.
3. Di bagian Kunci API, klik di kolom Tindakan yang terkait dengan kunci API yang ingin Anda cabut.

4. Klik Konfirmasi untuk mengonfirmasi operasi.

   Status kunci diperbarui menjadi Dicabut.

Mengedit detail aplikasi

Pengguna portal dapat mengedit detail aplikasi sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik aplikasi dalam daftar.
3. Edit kolom Nama atau Deskripsi di tab Detail Aplikasi.
4. Mengelola API dalam aplikasi, sebagaimana diperlukan.
5. Klik Simpan.

Menghapus aplikasi

Pengguna portal dapat menghapus aplikasi dari portal Anda, sebagai berikut:

1. Pilih Aplikasi dari drop-down akun pengguna.
2. Klik aplikasi dalam daftar.
3. Klik HAPUS.
4. Klik Konfirmasi untuk mengonfirmasi operasi.

Aplikasi ini telah dihapus dari daftar Aplikasi.