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 akan 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 ada produk API default
  • Apakah URL callback diperlukan
  • Apakah kunci API disetujui secara manual atau otomatis untuk produk API
  • Apakah ada informasi lain yang 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 melarang developer membuat, menghapus, atau mengedit aplikasi berdasarkan peran yang ditetapkan untuk developer. Misalnya, Anda dapat mengonfigurasi portal untuk membuat satu aplikasi default untuk semua developer saat developer mendaftar. Kemudian, Anda hanya mengizinkan beberapa developer untuk menambahkan aplikasi baru, mungkin berdasarkan struktur biaya atau karakteristik developer lainnya. Gunakan peran dan izin untuk mengontrol developer mana yang dapat membuat, menghapus, dan mengedit aplikasi. Lihat Menambahkan dan mengelola akun pengguna untuk mengetahui informasi selengkapnya.

Menentukan produk API yang tersedia di portal

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

Menetapkan tingkat akses saat membuat produk API

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

Untuk mengetahui 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 sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Tinjau peran portal developer dan penetapan pengguna:
    • Pilih Orang > Izin > Peran di menu administrasi Drupal, lalu tambahkan atau edit peran dan izin developer, sesuai kebutuhan.
    • Pilih Orang di menu administrasi Drupal dan edit penetapan pengguna dan peran, sesuai kebutuhan.
  3. Pilih Configuration > Dev Portal > API Product Role Access di menu administrasi Drupal.
  4. Pilih peran yang Anda inginkan agar dapat mengakses setiap produk API.
  5. Klik Simpan konfigurasi.

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 pemilihan produk API saat mendaftarkan aplikasi:

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

Anda juga dapat mengontrol elemen HTML yang muncul di formulir yang digunakan developer untuk memilih produk API. Opsi mencakup:

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

Untuk menetapkan opsi pemilihan produk API:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konfigurasi > Setelan Portal Dev > Setelan Aplikasi di menu administrasi Drupal.
  3. Di halaman Setelan Aplikasi, luaskan area API Product settings.
  4. Di bagian API Product Handling, pilih opsi yang mengontrol pemilihan produk API.
  5. Jika Anda menentukan opsi "Atribusikan 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 di produk API Anda menggunakan "OAuth tiga kaki" (jenis pemberian kode otorisasi), developer harus menentukan URL callback saat mendaftarkan aplikasi mereka. 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 mengirim URL ini ke Apigee Edge saat meminta kode otorisasi dan token akses, dan parameter redirect_uri harus cocok dengan parameter yang terdaftar. Untuk informasi selengkapnya, lihat Menerapkan jenis pemberian kode otorisasi.

Untuk mengontrol URL callback untuk pemilihan produk API:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konfigurasi > Setelan Portal Dev > Atribut Aplikasi di menu administrasi Drupal.
  3. Di halaman Setelan Aplikasi, luaskan area Setelan URL callback.
  4. Di bagian Penanganan URL Callback, 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 ini 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 min
  • Jumlah pesan
  • Jumlah error

Untuk mengaktifkan analisis di portal:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konfigurasi > Portal Dev > Setelan Aplikasi di menu administrasi Drupal.
  3. Di halaman Setelan aplikasi, luaskan area Setelan performa aplikasi.
  4. Centang kotak Tampilkan tab analisis Aplikasi Developer.
  5. Pilih Pengujian atau Produksi untuk Lingkungan untuk membuat kueri data analisis. Untuk portal yang tersedia secara 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 penautan Analytics untuk aplikasi.
  3. Pilih jenis analisis yang akan ditampilkan dan rentang tanggal:
  4. Informasi yang dipilih akan muncul:

Menyetujui atau mencabut kunci API secara manual untuk produk API

Saat developer menambahkan produk API ke aplikasi, lalu mendaftarkan aplikasi, portal akan menampilkan kembali 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:

  • Otomatis - Kunci API yang disetujui 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 maupun API, sebelum kunci tersebut dapat digunakan oleh developer untuk mengakses produk API. Anda dapat mencabut kunci yang disetujui secara manual nanti.

Lihat Membuat produk API untuk mengetahui informasi selengkapnya.

Jika portal Anda memungkinkan developer menambahkan beberapa produk API ke aplikasi, developer tersebut dapat menambahkan beberapa produk dengan Persetujuan kunci otomatis dan beberapa 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 menyetujui kunci. 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 dengan hak istimewa administrasi untuk organisasi Anda.
  2. Pilih API Platform di kotak dropdown 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 Anda setujui.
  6. Di halaman detail aplikasi, pilih tombol Edit di sudut 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 kini disetujui.

Mengontrol penyimpanan dalam cache produk dan aplikasi API

Informasi tentang produk API dan aplikasi developer disimpan dari 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, saat administrator backend menambahkan produk API baru, portal tidak langsung diperbarui dengan informasi tersebut.

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

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

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

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Dari menu Drupal, pilih Konfigurasi > Setelan Portal Dev > Setelan Aplikasi.
  3. Centang atau hapus centang Buat ulang cache Produk API dan Aplikasi Developer setiap kali cron berjalan.
  4. Simpan setelan Anda.

Untuk mengupdate cache secara manual:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Dari menu Drupal, pilih Ikon beranda > Hapus semua cache.

Menyesuaikan kolom formulir yang digunakan untuk mendaftarkan aplikasi

Saat developer mendaftarkan aplikasi, portal akan menampilkan formulir default:

Sebagai penyedia API, Anda dapat 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 diisi atau opsional
  • Ditampilkan oleh berbagai elemen HTML, seperti kotak teks, tombol pilihan, kotak centang, dan lainnya
  • Dapat disetel agar muncul di mana saja pada formulir antara kolom URL Callback 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 mengubah kolom tersebut di Edge, atau menggunakan Edge management API untuk mengakses kolom tersebut dari skrip.

Misalnya, lihat kolom formulir baru di UI pengelolaan Edge dengan membuka Publikasi > Aplikasi Developer, lalu memilih nama aplikasi. Nilai kolom baru akan muncul di bagian Custom Attributes pada halaman dengan nama yang sesuai dengan nama internal kolom:

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

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

Prosedur di bawah menjelaskan cara mengonfigurasi formulir pembuatan aplikasi menggunakan antarmuka administrator. Developer Drupal dapat melakukan penyesuaian tambahan, termasuk mengubah halaman 'Aplikasi Saya', dengan menggunakan hook kustom. Untuk mempelajari lebih lanjut cara mengubah perilaku melalui kode, lihat contoh API aplikasi dalam 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 sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pastikan modul Pengelolaan Atribut Aplikasi DevConnect diaktifkan.
  3. Pilih Konfigurasi > Setelan Portal Dev > Atribut Aplikasi Portal Dev 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 untuk Wajibkan atribut ini
    • Centang kotak untuk Tampilkan atribut ini.
    • Widget = Kotak Teks
    • Pilih Simpan untuk kembali ke halaman Atribut Aplikasi Portal Dev.
  6. Pilih Simpan Perubahan.
  7. Pilih Ikon beranda > Hapus semua cache 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 = intended_platforms
  • Nama Publik = Platform
  • Deskripsi = Tentukan satu atau beberapa platform untuk aplikasi Anda.
  • Hapus centang pada kotak untuk Wajibkan atribut ini
  • Centang kotak Tampilkan atribut ini.
  • Widget = Daftar Kotak Centang
  • Pilih Simpan untuk kembali ke halaman Atribut Aplikasi Dev Portal.

Untuk mengurutkan ulang atribut pada formulir:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konfigurasi > Setelan Portal Dev > Atribut Aplikasi Portal Dev di menu administrasi Drupal.
  3. Pilih simbol plus, +, di kolom Nama, lalu tarik properti ke lokasi tempat Anda ingin menampilkannya dalam formulir.
  4. Simpan perubahan.