Mendaftarkan developer aplikasi

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Daftarkan dan kelola developer aplikasi Anda, seperti yang dijelaskan di bagian berikut. (Pendaftaran aplikasi adalah proses terpisah, seperti yang dijelaskan dalam Mengontrol akses ke API Anda dengan mendaftarkan aplikasi).

Pengantar

Apigee memberikan banyak manfaat yang sepenuhnya bergantung pada pengetahuan tentang siapa yang memanggil API Anda. Misalnya, keamanan API, pengelolaan traffic, dan sejumlah besar data analisis bergantung pada pengetahuan tentang siapa yang melakukan panggilan. Lalu, bagaimana Apigee mengetahui siapa yang memanggil API Anda? Dengan membaca informasi unik di setiap panggilan API, seperti ID pengguna, kunci API, atau token OAuth. Informasi unik tersebut mengunci atau membuka kunci fungsi yang Anda bangun ke dalam proxy API, sehingga Anda memiliki kontrol penuh atas akses dan perilaku API.

Itulah sebabnya developer aplikasi perlu mendaftar untuk menggunakan API Anda. Setelah ditambahkan, developer mendaftarkan aplikasi mereka, memilih API yang ingin digunakan, dan menerima kredensial API unik (kunci dan rahasia konsumen) yang diperlukan untuk mengakses API Anda.

Peringatan: Keamanan API, pengelolaan traffic, dan analisis developer/aplikasi bergantung pada konfigurasi proxy API yang tepat. Misalnya, Anda perlu menambahkan kebijakan yang tepat ke proxy, seperti validasi kunci API atau verifikasi token akses OAuth, penerapan kuota, dan pembatasan frekuensi. Kebijakan tersebut mengidentifikasi developer dan aplikasi tertentu yang melakukan panggilan, yang pada gilirannya memungkinkan penegakan keamanan API, pengelolaan traffic khusus developer atau aplikasi, pengambilan analisis API, dan fungsi lainnya. Secara teknis, Anda dapat mengembangkan API terbuka yang tidak memeriksa kunci API atau token akses, yang berarti Anda tidak perlu mendaftarkan developer. Namun, kami sangat tidak menyarankan hal ini karena Anda akan kehilangan keamanan API, kehilangan kontrol atas performa (melalui pengelolaan traffic yang baik), kehilangan data analisis, dan tidak mendapatkan manfaat utama lainnya yang disediakan Apigee.

Cara mendaftarkan developer aplikasi

Mendaftarkan developer aplikasi menggunakan salah satu metode berikut:

• Jika Anda memiliki akun Apigee berbayar, developer dapat mendaftar sendiri melalui portal developer. Untuk mengetahui informasi selengkapnya, lihat salah satu bagian berikut berdasarkan jenis portal developer:
  • Portal terintegrasi: Membuat akun pengguna di portal terintegrasi
  • Drupal 10: Mendaftarkan developer aplikasi
• Administrator dapat mendaftarkan developer aplikasi menggunakan API.
• Sebagai administrator portal developer, kelola developer secara langsung di portal Anda, seperti yang dijelaskan di bagian berikut:
  • Portal terintegrasi: Mengelola pengguna untuk mengelola akun pengguna.
    Catatan: Setelah pengguna membuat aplikasi di portal terintegrasi, seperti yang dijelaskan di bagian ini, informasi akun pengguna disinkronkan dan tersedia di Apigee di halaman Developer. Catatan developer aplikasi dikaitkan dengan akun menggunakan alamat email pengguna. Untuk mengetahui informasi selengkapnya tentang tempat penyimpanan informasi akun dan aplikasi terkait, lihat Tempat penyimpanan informasi akun developer aplikasi.
  • Drupal 10: Pahami cara developer aplikasi berinteraksi dengan modul Apigee
• Sebagai administrator organisasi, kelola developer menggunakan UI atau API Apigee, seperti yang dijelaskan di bagian berikut.

Catatan: Saat pengguna portal membuat tim di portal terintegrasi, informasi tim developer akan disimpan di Apigee dan alamat email unik yang dibuat otomatis akan dibuat untuk berfungsi sebagai kunci utama yang digunakan oleh Apigee untuk mengidentifikasi tim developer. Untuk mengetahui informasi selengkapnya, lihat Tempat penyimpanan informasi tim developer (beta).

Rekomendasi untuk mengelola akun pengguna di portal developer

Apigee merekomendasikan agar Anda mengelola akun pengguna secara langsung di portal developer.

Jika Anda menggunakan portal terintegrasi, cara ini adalah satu-satunya cara untuk memastikan bahwa akun pengguna di portal terintegrasi dan Apigee tetap disinkronkan.

Jika Anda menggunakan portal developer berbasis Drupal, mengelola akun pengguna langsung di portal developer memberikan keuntungan berikut:

• Saat menambahkan developer melalui antarmuka administrator di portal, Anda dapat menyetel sandi developer untuk portal dan memicu pesan email otomatis yang dikirim ke developer.

  Saat menambahkan atau mengubah developer menggunakan Apigee, tidak ada email yang dikirim ke developer dan Anda tidak dapat menyetel sandi untuk developer di portal. Oleh karena itu, developer harus menyetel ulang sandi mereka di portal sebelum dapat login ke portal.

• Setiap perubahan yang dilakukan pada akun developer di portal akan otomatis dikirim ke Apigee.

Jika Anda memutuskan untuk mengelola akun pengguna berbasis Drupal menggunakan Apigee, Anda harus menyelaraskan developer aplikasi antara portal dan Apigee.

Menjelajahi halaman Developer

Akses dan jelajahi halaman Developer menggunakan UI Apigee.

Catatan: Untuk portal terintegrasi, akun pengguna dikelola seperti yang dijelaskan dalam Mengelola pengguna. Setelah developer membuat aplikasi di portal terintegrasi, seperti yang dijelaskan dalam Mendaftarkan aplikasi, catatan developer terpisah dibuat untuk melacak aplikasi yang terkait dengan akun pengguna dan dapat diakses di halaman Developer. Rekaman developer dikaitkan menggunakan alamat email pengguna.

Untuk mengakses halaman Distribusi > Developer:

Buka Developer

Halaman Developer memungkinkan Anda untuk:

• Menambahkan developer
• Melihat dan mengedit detail developer, termasuk hal-hal berikut:
• Mengelola atribut khusus
• Mengaktifkan atau menonaktifkan developer
• Mengekspor data publikasi
• Menghapus developer
• Menelusuri daftar developer

Menambahkan developer

Untuk menambahkan developer:

1. Akses halaman Developer.
2. Klik + Create.
3. Masukkan detail developer, termasuk nama depan, nama belakang, email, dan nama pengguna.
4. Klik Tambahkan.

Lihat juga Mengelola pengguna.

Melihat dan mengedit detail developer

Melihat dan mengedit detail developer.

Untuk melihat dan mengedit detail developer:

1. Akses halaman Developer.
2. Klik baris developer yang ingin Anda lihat dan edit untuk membuka detail developer.
3. Di bagian Detail, informasi berikut ditampilkan. Klik Edit untuk mengedit detail developer, sesuai kebutuhan.

   Detail	Deskripsi
   Detail	Nama depan dan belakang, nama pengguna, dan email developer; status dan durasi pendaftaran; serta ID developer.
   Atribut khusus	Atribut kustom yang ditentukan untuk developer. Konfigurasi atribut khusus, sesuai kebutuhan. Untuk mengetahui informasi selengkapnya, lihat: Mengelola atribut kustom untuk developer
   Aplikasi	Aplikasi yang telah didaftarkan oleh developer. Lihat Mengontrol akses ke API Anda dengan mendaftarkan aplikasi.

4. Aktifkan atau nonaktifkan developer di kolom Status.
   Untuk mengetahui informasi selengkapnya, lihat Mengaktifkan dan menonaktifkan developer.

Apigee menyimpan entitas berikut dalam cache selama minimal 180 detik setelah entitas tersebut diakses.

• Token akses OAuth. Artinya, elemen ExpiresIn pada kebijakan OAuth v2 tidak akan dapat mengakhiri masa berlaku token akses dalam waktu kurang dari 180 detik.
• Entitas Key Management Service (KMS) (Aplikasi, Developer, Produk API).
• Atribut kustom pada token OAuth dan entitas KMS.

Mengelola atribut khusus untuk developer

Tambahkan hingga 18 atribut kustom untuk setiap developer.

Untuk mengelola atribut khusus:

1. Akses halaman Developer.
2. Klik baris developer yang atribut kustomnya ingin Anda kelola untuk membuka detail developer.
3. Klik Edit.
4. Klik + Tambahkan atribut di bagian Atribut Kustom.
5. Masukkan nama dan nilai atribut.
6. Klik Simpan.
7. Untuk menghapus atribut khusus, klik Edit, lalu Hapus, lalu klik Simpan.

Mengaktifkan dan menonaktifkan developer

Saat developer aplikasi mendaftar sendiri di portal Anda, Anda dapat mengonfigurasi apakah mereka aktif secara default atau tidak.

Jika tidak aktif, developer tetap dapat login ke portal developer dan membuat aplikasi, tetapi tidak ada kunci API yang sesuai yang akan berfungsi. Aplikasi developer tetap mempertahankan status yang disetujui (atau lainnya), begitu juga kunci API, meskipun tidak valid saat developer tidak aktif.

Catatan: Saat Anda menonaktifkan developer, mungkin perlu waktu beberapa menit agar perubahan diperbarui di semua pemroses pesan. Hingga saat itu, beberapa panggilan oleh aplikasi developer mungkin berhasil.

Untuk mengaktifkan atau menonaktifkan developer:

1. Akses halaman Developer.
2. Klik baris developer yang ingin Anda aktifkan atau nonaktifkan untuk membuka detail developer.
3. Klik Edit.
4. Di bagian Detail, tetapkan kolom Status ke Aktif atau Tidak aktif, sesuai kebutuhan.
5. Klik Simpan.
6. Ulangi langkah-langkah tersebut jika developer berada di beberapa organisasi.

Mengekspor data publikasi

Bagian ini menjelaskan cara mengekspor data publikasi untuk developer, aplikasi, atau produk API sebagai file nilai yang dipisahkan koma (CSV) atau file JSON.

Prasyarat:

• Bucket Cloud Storage
• Akses baca ke data yang Anda ekspor
• Akses baca + tulis ke bucket Cloud Storage

Untuk mengetahui informasi selengkapnya tentang bucket, lihat artikel berikut:

• Tentang bucket Cloud Storage
• Membuat bucket
• Mencantumkan bucket

Untuk mengekspor data publikasi:

1. Buat bucket Cloud Storage atau dapatkan nama bucket yang ada.
2. Akses salah satu halaman berikut:

   • Di konsol Google Cloud , buka halaman Distribution > Developers.

     Buka Developer

   • Di konsol Google Cloud , buka halaman Distribution > Apps.

     Buka Aplikasi

   • Di konsol Google Cloud , buka halaman Distribution > API Products.

     Buka Produk

3. Klik Ekspor.
4. Dialog Simpan tabel sebagai akan ditampilkan. Ketik nama bucket Cloud Storage dan tentukan format ekspor; JSON atau CSV.
5. Klik Simpan. Operasi yang berjalan lama (LRO) dimulai. Status LRO ditampilkan di ikon Notifikasi.
6. Setelah ekspor selesai, klik Download di notifikasi. Halaman bucket Cloud Storage untuk file akan terbuka.
7. Klik Download. File didownload ke komputer lokal Anda.

Catatan tentang data yang diekspor:

• Struktur data yang diekspor mengikuti definisi proto secara persis sehingga dokumentasi proto dapat digunakan sebagai referensi untuk struktur data yang diekspor. Lihat:
  • Developer
  • Aplikasi
  • Produk API
• Tidak seperti UI Apigee Classic, setiap resource memiliki tombol ekspor yang independen dan khusus.
• Ekspor CSV tidak mencantumkan kolom berulang atau bertingkat dari proto karena tidak dapat direpresentasikan dengan benar dalam struktur data tabel. Untuk mendapatkan informasi ini, ekspor JSON harus digunakan.
• File yang diekspor diberi nama ExportFinal_{hash}.

Menghapus developer

Peringatan: Menghapus developer akan sepenuhnya menghapus developer tersebut dan artefak terkaitnya (seperti aplikasi dan kunci API) dari organisasi Anda. Untuk menghindari penghapusan developer dan artefak mereka secara permanen, pertimbangkan untuk menonaktifkan developer.

Untuk menghapus developer:

1. Akses halaman Developer.
2. Posisikan kursor Anda di baris developer yang ingin Anda hapus.
3. Klik Lainnya, lalu klik Hapus.
4. Klik Delete untuk mengonfirmasi penghapusan.

Menyinkronkan developer aplikasi antara portal dan Apigee

Jika Anda menggunakan portal developer berbasis Drupal untuk memublikasikan API, perubahan yang dilakukan pada developer aplikasi menggunakan Apigee tidak akan diteruskan ke portal. Anda harus login ke portal sebagai administrator portal dan menyinkronkan portal dengan Apigee agar perubahan tersebut muncul di portal.

Catatan: Jika Anda menggunakan portal developer berbasis Drupal, Apigee merekomendasikan agar Anda mengelola developer aplikasi secara langsung di portal, bukan menggunakan Apigee. Lihat Rekomendasi untuk mengelola akun pengguna di portal developer.

Untuk menyinkronkan portal developer Anda dengan developer aplikasi yang ditentukan di Apigee, lihat bagian berikut:

Drupal 10: Menyinkronkan developer dengan Apigee

Mengelola developer menggunakan API

Mengelola developer menggunakan Developer API.