Mengonfigurasi pendaftaran aplikasi

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

Developer menggunakan halaman Aplikasi Saya di portal Layanan Developer untuk mendaftarkan aplikasi. Developer mengakses halaman Aplikasi Saya dari menu utama portal:

Untuk mendaftarkan aplikasi baru, developer memilih tombol Tambahkan aplikasi baru di halaman Aplikasi Saya.

Portal kemudian menampilkan formulir pendaftaran aplikasi default:

Secara default, developer hanya perlu menentukan nama aplikasi, URL callback, dan daftar produk API yang akan ditambahkan ke aplikasi.

Sebagai penyedia API, Anda memiliki kontrol penuh atas proses pendaftaran aplikasi. Misalnya, Anda dapat mengonfigurasi:

  • Daftar produk API yang tersedia di portal
  • Apakah tersedia produk API default atau tidak
  • Apakah URL callback diperlukan atau tidak
  • Apakah kunci API disetujui secara manual atau otomatis untuk produk API
  • Apakah informasi lain diperlukan di halaman Tambahkan Aplikasi untuk mendaftarkan aplikasi

Topik ini menjelaskan cara mengonfigurasi proses pendaftaran aplikasi untuk portal Anda. Namun, topik ini tidak menjelaskan cara membuat produk API. Untuk mengetahui informasi selengkapnya, lihat:

Anda dapat mengonfigurasi portal untuk mencegah developer membuat, menghapus, atau mengedit aplikasi berdasarkan peran yang ditetapkan kepada developer. Misalnya, Anda dapat mengonfigurasi portal untuk membuat satu aplikasi default bagi semua developer saat developer mendaftar. Kemudian, Anda hanya mengizinkan beberapa developer untuk menambahkan aplikasi baru, mungkin berdasarkan struktur biaya atau karakteristik lain dari developer. Gunakan peran dan izin untuk mengontrol developer mana yang dapat membuat, menghapus, dan mengedit aplikasi. Lihat Menambahkan dan mengelola akun pengguna untuk informasi selengkapnya.

Menentukan produk API yang tersedia di portal

Ada dua cara untuk menentukan produk API yang tersedia saat developer mengakses portal:

Menentukan tingkat akses saat membuat produk API

Saat membuat produk API, Anda menentukan opsi tingkat akses produk, seperti yang ditunjukkan di bawah:

Untuk informasi selengkapnya tentang pengaruh tingkat akses terhadap ketersediaan produk API di portal developer Drupal 7, lihat Tingkat akses.

Membatasi akses ke produk API berdasarkan peran

Dengan mengaktifkan modul Drupal Akses Peran Produk API, Anda dapat menentukan peran yang dapat mengakses setiap produk API.

Untuk membatasi akses ke produk API berdasarkan peran developer:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Tinjau peran portal developer dan tugas pengguna:
    • Pilih People > Permissions > Peran di menu administrasi Drupal, lalu tambahkan atau edit peran dan izin developer, sesuai kebutuhan.
    • Pilih People di menu administrasi Drupal, lalu edit penetapan pengguna dan peran, sesuai kebutuhan.
  3. Pilih Configuration > Dev Portal > API Product Role Access di menu administrasi Drupal.
  4. Pilih peran yang ingin Anda akses untuk setiap produk API.
  5. Klik Save configuration.

Mengonfigurasi cara developer mengaitkan produk API dengan aplikasi

Untuk mendaftarkan aplikasi baru, developer memilih tombol Tambahkan aplikasi baru di halaman Aplikasi Saya untuk membuka formulir Tambahkan Aplikasi:

Berdasarkan cara Anda mengonfigurasi portal, developer dapat memilih satu atau beberapa produk API untuk dikaitkan dengan aplikasi pada saat pendaftaran aplikasi. Atau, Anda dapat menentukan produk default yang ditetapkan ke semua aplikasi.

Opsi konfigurasi berikut tersedia di portal untuk mengontrol pilihan produk API saat mendaftarkan aplikasi:

  • Jangan mengaitkan aplikasi dengan Produk API apa pun.
  • Kaitkan semua aplikasi dengan satu atau beberapa Produk API Default (yang dikonfigurasi di bawah). Developer tidak dapat menambahkan produk API lain ke aplikasi.
  • Mengizinkan pemilihan produk API tunggal, tetapi tidak mewajibkannya.
  • Mewajibkan pemilihan satu produk API.
  • Mengizinkan pemilihan beberapa Produk API, tetapi jangan mewajibkannya.
  • Izinkan pemilihan beberapa Produk API, dan wajibkan setidaknya satu Produk API.

Anda juga dapat mengontrol elemen HTML yang muncul pada formulir yang digunakan developer untuk memilih produk API. Opsinya meliputi:

  • Daftar dropdown.
  • Kotak centang atau tombol pilihan. Kotak centang akan muncul saat developer dapat memilih beberapa produk API dan tombol pilihan akan muncul saat developer hanya dapat memilih satu produk API.

Untuk menetapkan opsi pemilihan produk API:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Configuration > Dev Portal Settings > Application Settings di menu administrasi Drupal.
  3. Di halaman Application Settings, luaskan area API Product settings.
  4. Di bagian API Product Handling, pilih opsi yang mengontrol pemilihan produk API.
  5. Jika Anda menentukan opsi "Mengaitkan semua aplikasi dengan satu atau beberapa Produk API Default (dikonfigurasi di bawah)", tetapkan produk default di bagian Produk API Default.
  6. Di bagian Widget Produk API, pilih elemen HTML yang digunakan oleh developer untuk memilih produk API.
  7. Simpan konfigurasi.

Mengonfigurasi penanganan URL callback

Jika proxy API dalam produk API Anda menggunakan "three-legged OAuth" (jenis pemberian kode otorisasi), developer harus menentukan URL callback saat mereka mendaftarkan aplikasi. URL callback biasanya menentukan URL aplikasi yang ditetapkan untuk menerima kode otorisasi atas nama aplikasi klien. Selain itu, string URL ini digunakan untuk validasi. Klien diwajibkan untuk mengirimkan URL ini ke Apigee Edge saat meminta kode otorisasi dan token akses, dan parameter redirect_uri harus cocok dengan yang terdaftar. Untuk informasi selengkapnya, lihat Menerapkan jenis pemberian kode otorisasi.

Guna mengontrol URL callback untuk pemilihan produk API:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Configuration > Dev Portal Settings > Application Attributes di menu administrasi Drupal.
  3. Di halaman Application Settings, luaskan area Callback URL settings.
  4. Di bagian Penanganan URL Panggilan Balik, pilih salah satu opsi berikut.
    • URL callback diperlukan untuk semua aplikasi developer.
    • URL callback bersifat opsional untuk semua aplikasi developer.
    • URL callback tidak diperlukan atau ditampilkan.
  5. Simpan konfigurasi.

Menampilkan analisis untuk penggunaan aplikasi

Portal dapat menampilkan informasi analisis tentang penggunaan aplikasi. Jika tampilan analisis diaktifkan, developer aplikasi dapat melihat analisis di halaman Aplikasi Saya untuk setiap aplikasi. Misalnya, developer dapat menampilkan analisis berikut untuk aplikasi:

  • Throughput
  • Waktu respons maksimum
  • Waktu respons minimum
  • Jumlah pesan
  • Jumlah error

Untuk mengaktifkan analisis di portal:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Configuration > Dev Portal > Application Settings di menu administrasi Drupal.
  3. Di halaman Application settings, luaskan area App performance settings.
  4. Centang kotak Tampilkan tab analisis Aplikasi Developer.
  5. Pilih Test atau Production untuk Environment guna membuat kueri untuk data analisis. Untuk portal yang tersedia untuk publik, biasanya Anda akan memilih Produksi.
  6. Simpan konfigurasi.

Untuk menampilkan analisis di portal untuk aplikasi:

  1. Pilih nama aplikasi di halaman Aplikasi Saya.
  2. Pilih link Analytics untuk aplikasi.
  3. Pilih jenis analisis yang akan ditampilkan dan rentang tanggalnya:
  4. Informasi yang dipilih muncul:

Menyetujui atau mencabut kunci API secara manual untuk produk API

Saat developer menambahkan produk API ke aplikasi lalu mendaftarkan aplikasi, portal akan mengembalikan kunci API untuk aplikasi tersebut kepada developer. Kemudian, developer menggunakan kunci API tersebut untuk mengakses proxy API yang dipaketkan oleh produk API yang terkait dengan aplikasi.

Anda mengontrol proses persetujuan kunci untuk setiap produk API saat membuat produk API:

Proses persetujuan dapat berupa:

  • Otomatis - Kunci API yang disetujui akan ditampilkan oleh portal untuk produk API saat developer mendaftarkan aplikasi. Anda dapat mencabut kunci yang disetujui secara otomatis nanti.
  • Manual - Kunci API ditampilkan oleh portal saat developer mendaftarkan aplikasi, tetapi kunci tidak diaktifkan untuk produk API apa pun yang menggunakan Persetujuan kunci manual. Administrator harus menyetujui kunci API secara manual, baik di UI pengelolaan Edge atau API, sebelum dapat digunakan oleh developer untuk mengakses produk API. Anda dapat mencabut kunci yang disetujui secara manual nanti.

Lihat Membuat produk API untuk informasi selengkapnya.

Jika portal Anda mengizinkan developer menambahkan beberapa produk API ke aplikasi, developer mungkin akan menambahkan beberapa produk dengan Persetujuan kunci otomatis dan beberapa lainnya dengan Manual. Developer dapat langsung menggunakan kunci API yang ditampilkan untuk semua produk API yang disetujui secara otomatis sambil menunggu persetujuan akhir untuk produk yang memerlukan persetujuan Manual.

Untuk melihat daftar produk API untuk aplikasi, dan status persetujuan kunci untuk produk API, developer memilih nama aplikasi di halaman Aplikasi Saya, lalu memilih link Produk:

Dalam contoh ini, produk Premium Weather API menggunakan persetujuan Manual, dan menunggu administrator untuk menyetujui kunci tersebut. Produk API Gratis menggunakan Persetujuan otomatis dan penggunaan kunci untuk mengaksesnya telah disetujui.

Untuk menyetujui atau mencabut kunci secara manual:

  1. Login ke UI pengelolaan Edge sebagai pengguna yang memiliki hak istimewa administrasi untuk organisasi Anda.
  2. Pilih API Platform pada kotak drop-down di pojok kanan atas.
  3. Pilih Publikasikan > Aplikasi developer untuk membuka daftar aplikasi developer.
  4. Pilih tombol Tertunda untuk melihat daftar aplikasi dengan permintaan kunci yang tertunda:

  5. Pilih nama aplikasi yang ingin disetujui.
  6. Di halaman detail aplikasi, pilih tombol Edit di pojok kanan atas.
  7. Dalam daftar produk API untuk aplikasi, di bagian Tindakan:
    • Untuk menyetujui kunci, pilih tombol Setujui untuk setiap produk API yang memerlukan persetujuan manual.

    • Untuk mencabut kunci yang disetujui, pilih tombol Cabut di bagian Tindakan untuk produk API guna mencabut akses.

  8. Simpan aplikasi. Kunci API sekarang telah disetujui.

Mengontrol penyimpanan produk dan aplikasi API dalam cache

Informasi tentang produk API dan aplikasi developer disimpan secara jarak jauh dari portal di Apigee Edge. Artinya, perubahan pada produk dan aplikasi API dapat dilakukan dari UI atau API Edge, tanpa melalui portal. Misalnya, ketika administrator backend menambahkan produk API baru, portal tidak segera diperbarui dengan informasi tersebut.

Untuk memastikan bahwa portal tetap sinkron dengan backend Edge, Anda dapat memicu pembaruan cache portal secara manual, memperbarui cache secara otomatis saat cron job portal berjalan, atau keduanya. Misalnya, jika Anda mengonfigurasi cron job agar sering dijalankan, seperti setiap 5 atau 10 menit, Anda mungkin tidak ingin overhead memperbarui produk API dan cache aplikasi developer terlalu sering. Dalam situasi ini, Anda kemudian dapat memicu pembaruan cache secara manual. Namun, jika cron job berjalan setiap jam atau dua jam, waktu yang diperlukan untuk mengupdate cache mungkin tidak terlalu berdampak.

Secara default, portal dikonfigurasi untuk membangun ulang produk API dan cache aplikasi developer setiap kali cron berjalan.

Untuk menentukan apakah akan mem-build ulang produk API dan aplikasi developer melakukan cache setiap kali cron berjalan:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Dari menu Drupal, pilih Configuration > Dev Portal Settings > Application Settings.
  3. Centang atau hapus centang pada Rebuild API Product dan Developer App caches one time cron running.
  4. Simpan setelan Anda.

Untuk memperbarui cache secara manual:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Dari menu Drupal, pilih Home icon > Flush all caches.

Menyesuaikan kolom formulir yang digunakan untuk mendaftarkan aplikasi

Saat developer mendaftarkan aplikasi, portal akan menampilkan bentuk default:

Sebagai penyedia API, Anda mungkin ingin mengubah formulir ini untuk meminta developer memberikan informasi tambahan seperti ID pelanggan, platform target aplikasi, atau informasi lainnya. Portal ini memberi Anda kemampuan untuk menambahkan kolom baru ke formulir ini. Kolom ini dapat berupa:

  • Wajib atau opsional
  • Ditampilkan oleh elemen HTML yang berbeda, seperti kotak teks, tombol pilihan, kotak centang, dan lainnya
  • Dapat ditetapkan untuk muncul di mana saja pada formulir antara kolom Callback URL dan kolom Produk

Untuk mempelajari cara menyesuaikan formulir pendaftaran aplikasi yang tersedia dari portal developer, tonton video ini.

Misalnya, formulir berikut menunjukkan kolom wajib diisi untuk ID Pelanggan dan kolom opsional untuk platform target:

Saat Anda menambahkan kolom baru ke formulir, nilai kolom akan otomatis diupload ke Edge, bersama dengan semua kolom lainnya, saat developer mengirimkan formulir. Artinya, Anda dapat melihat atau memodifikasi kolom tersebut di Edge, atau menggunakan API pengelolaan Edge untuk mengakses kolom tersebut dari skrip.

Misalnya, lihat kolom formulir baru di UI pengelolaan Edge dengan membuka Publish > Developer Apps, lalu memilih nama aplikasi. Nilai kolom baru akan muncul pada area Atribut Kustom pada halaman dengan nama yang sesuai dengan nama internal kolom:

Nilai kolom juga ditampilkan di area Detail aplikasi di halaman Aplikasi Saya milik developer:

Developer juga dapat mengedit nilai dengan memilih link Edit untuk aplikasi tersebut di halaman Aplikasi Saya.

Prosedur di bawah ini menjelaskan cara mengonfigurasi formulir pembuatan aplikasi menggunakan antarmuka administrator. Developer Drupal dapat melakukan penyesuaian tambahan, termasuk memodifikasi halaman 'Aplikasi Saya', menggunakan hook kustom. Untuk mempelajari lebih lanjut cara mengubah perilaku melalui kode, lihat contoh API aplikasi di file: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Untuk menambahkan kolom ke formulir pendaftaran aplikasi:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pastikan modul Pengelolaan Atribut Aplikasi DevConnect diaktifkan.
  3. Pilih Configuration > Dev Portal Settings > Dev Portal App Attributes di menu administrasi Drupal.
  4. Pilih tombol Add Dev Portal App Attribute di bagian atas halaman.
  5. Konfigurasikan kolom. Misalnya, untuk kolom ID Pelanggan yang ditampilkan di atas, gunakan setelan berikut:
    • Nama Internal = cust_id. Ini adalah nama variabel yang digunakan untuk menyimpan nilai kolom.
    • Nama Publik = ID Pelanggan
    • Deskripsi = Masukkan ID pelanggan Anda.
    • Centang kotak Wajibkan atribut ini
    • Centang kotak Tampilkan atribut ini.
    • Widget = Kotak Teks
    • Pilih Simpan untuk kembali ke halaman Dev Portal App Attributes.
  6. Pilih Simpan Perubahan.
  7. Pilih ikon Home > Flush all caches dari menu Drupal.
    Anda mungkin harus menghapus cache browser sebelum kolom baru muncul di formulir.

Untuk menambahkan kolom opsional bagi developer guna menentukan platform untuk aplikasi, tetapkan atribut kolom sebagai:

  • Nama Internal = Destination_platforms
  • Nama Publik = Platform
  • Deskripsi = Tentukan satu atau beberapa platform untuk aplikasi Anda.
  • Kosongkan kotak centang untuk Wajibkan atribut ini
  • Pilih kotak centang untuk Tampilkan atribut ini.
  • Widget = Daftar Kotak Centang
  • Pilih Simpan untuk kembali ke halaman Dev Portal App Attributes.

Untuk menyusun ulang atribut di formulir:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Configuration > Dev Portal Settings > Dev Portal App Attributes di menu administrasi Drupal.
  3. Pilih simbol plus, +, di bawah kolom Name, lalu tarik properti ke lokasi tempat Anda ingin menampilkannya dalam formulir.
  4. Simpan perubahan.