Cara pengguna portal berinteraksi dengan portal Anda

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Secara langsung, portal developer memungkinkan pengguna portal untuk 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 yang diinginkan.

Login ke portal menggunakan kredensial pengguna (penyedia identitas bawaan)

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

Buat akun pengguna di portal terintegrasi

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

Pengguna portal membuat akun pengguna pada portal terintegrasi sebagai berikut:

  1. Buka portal.

  2. Klik Sign In.

    Halaman Login akan ditampilkan.

  3. Klik Create account.

    Halaman Buat akun Anda akan ditampilkan.

    Dialog untuk membuat akun Anda

  4. Isi formulir.

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

  5. Tinjau dan setujui persyaratan.

  6. Klik Buat Akun.

  7. Lengkapi formulir CAPTCHA, lalu klik Verifikasi (jika ditampilkan).

    Akun pengguna dibuat dan email konfirmasi akan dikirim.

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

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

  9. 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).

Pengguna portal akan login sebagai berikut:

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

Mengubah sandi

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

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

  5. Klik Kirim Link Reset Sandi.

    Link reset sandi dikirim ke email.

  6. Klik link di email konfirmasi.

  7. Masukkan sandi baru dan konfirmasi.

    Kata sandi minimal harus 8 karakter dan mengandung minimal salah satu dari berikut ini: angka, huruf kecil, huruf besar, dan karakter khusus.

  8. Klik Buat Sandi Baru.

Login ke portal menggunakan autentikasi SAML (beta)

Jika SAML identity provider 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 Anda.

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

    Halaman APIs

  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.

Membagikan tanggung jawab atas aplikasi menggunakan tim developer (beta)

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

Tentang peran tim developer

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

Role 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.
Viewer Hak istimewa hanya baca untuk anggota tim developer, detail tim developer, dan aplikasi.

Lihat halaman Tim

Halaman Teams menampilkan tim developer tempat Anda menjadi anggota.

Untuk mengakses halaman Tim:

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

Halaman Teams ditampilkan sehingga Anda dapat:

Tambahkan tim developer

Untuk menambahkan tim developer:

  1. Login ke portal.
  2. Pilih Tim 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 lainnya.

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

  7. Klik Create.

Mengedit keanggotaan dan peran tim developer

Untuk mengedit keanggotaan dan peran tim developer:

  1. Login ke portal.
  2. Pilih Tim dari drop-down akun pengguna di portal.
  3. Klik baris tim developer yang ingin Anda edit dan yang Anda miliki sebagai 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.

  5. Klik Simpan.

Menghapus diri Anda dari tim developer

Untuk menghapus diri Anda dari tim developer:

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

Menghapus tim developer

Untuk menghapus tim developer:

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

Daftarkan aplikasi

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

Mendaftarkan aplikasi developer

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. Pilih pemilik Aplikasi di menu drop-down Pemilik.

    Secara default, Anda adalah pemilik aplikasi. Jika diinginkan, pilih tim developer dari menu drop-down untuk berbagi tanggung jawab atas aplikasi dengan anggota tim developer lainnya. Lihat Membagikan tanggung jawab atas aplikasi menggunakan tim developer (beta).

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

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

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

    Untuk mengetahui informasi selengkapnya, lihat Tentang URL callback.

  7. Klik Create.

Mendaftarkan aplikasi tim developer

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

Untuk mempelajari lebih lanjut cara:

Untuk mendaftarkan aplikasi tim developer:

  1. Pilih Tim 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 diinginkan, pilih tim developer lain atau Anda sendiri sebagai pemilik dari menu drop-down.

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

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

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

    Untuk mengetahui informasi selengkapnya, lihat Tentang URL callback.

  8. Klik Create.

Mengelola API di aplikasi

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

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

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 ikon aktifkan atau ikon nonaktifkan untuk mengaktifkan atau menonaktifkan akses ke API dari aplikasi.
  4. Untuk Authenticated API, tambahkan atau edit URL callback, sesuai kebutuhan.

Melihat kunci dan rahasia API 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 sudah Aktif. Jika kunci API Anda memerlukan persetujuan dan belum disetujui, statusnya akan ditampilkan sebagai Menunggu Persetujuan.
  5. Klik Show secret untuk melihat rahasia.
  6. Arahkan kursor ke atas kunci API atau rahasia dan klik ikon-hapus untuk menyalinnya ke papan klip.

Merotasi 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 akan dibuat dengan hak API yang sama seperti kunci asli. Kunci API asli tetap aktif sewaktu Anda mentransisikannya tidak digunakan. 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 Tambahkan Kunci.
  4. Klik Confirm di kotak dialog untuk mengonfirmasi operasi.
  5. Secara opsional, cabut kunci API lama, seperti yang dijelaskan di bawah.

Mencabut kunci API untuk aplikasi

Bila pengguna portal merotasi kunci API, seperti yang dijelaskan di bagian sebelumnya, kunci API akan tetap aktif sewaktu Anda mentransisikan kunci API tersebut tidak digunakan. Anda harus mencabut kunci API untuk mencegah kredensialnya 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 ikon cabut di kolom Actions yang terkait dengan kunci API yang ingin Anda cabut.

  4. Klik Konfirmasi untuk mengonfirmasi operasi.

    Status kunci diperbarui menjadi Dicabut.

Edit 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 di aplikasi, sesuai kebutuhan.
  5. Klik Simpan.

Hapus aplikasi

Pengguna portal dapat menghapus aplikasi dari portal Anda, dengan cara berikut:

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

Aplikasi akan dihapus dan dihapus dari daftar Aplikasi.