Berkomunikasi antara portal berbasis Drupal dan Edge

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

Portal Layanan Developer berfungsi sebagai klien untuk Apigee Edge. Artinya, portal tidak berfungsi sebagai sistem mandiri. Sebagai gantinya, sebagian besar informasi yang digunakan oleh portal sebenarnya disimpan di Edge. Jika diperlukan, portal akan membuat permintaan HTTP atau HTTPS untuk mengambil informasi dari Edge atau mengirim informasi ke Edge.

Edge tidak membuat permintaan ke portal, tetapi hanya merespons permintaan yang dibuat dari portal. Oleh karena itu, semua interaksi antara portal dan Edge dimulai oleh portal.

Mengonfigurasi koneksi antara portal dan Edge

Ada tiga informasi yang perlu dikomunikasikan portal dengan Edge, seperti yang tercantum di bawah.

  • URL endpoint Edge

    Endpoint default untuk Edge versi berbasis cloud adalah https://api.enterprise.apigee.com/v1.

    Untuk penginstalan Cloud Pribadi, URL-nya berbentuk: http://EdgePrivateCloudIp:8080/v1 atau https://EdgePrivateCloudIp:TLSport/v1.

    Dengan EdgePrivateCloudIp adalah alamat IP server Edge Management Server dan TLSport adalah port TLS/SSL untuk Edge management API. Misalnya, 8443.
  • Nama organisasi Apigee

    Ini adalah nama organisasi Anda di Edge. Anda menyiapkan organisasi saat membuat akun di Edge.
  • Nama pengguna dan sandi administrator developer

    Panggilan dari portal ke Edge diautentikasi dan memerlukan pengguna dengan hak istimewa Administrator Developer. Saat Portal Developer disediakan untuk Anda, peran Developer Administrator akan ditambahkan ke organisasi Anda. Peran ini, yang mencakup satu pengguna bernama devadmin+{org_name}@apigee.com, hanya ditujukan untuk menghubungkan Developer Portal ke organisasi Edge Anda. Karena portal menampilkan aplikasi developer Edge, produk API, dan sebagainya, portal harus tetap sinkron dengan organisasi Edge Anda dengan melakukan panggilan API pengelolaan yang memerlukan autentikasi. "Pengguna" devadmin memiliki izin yang diperlukan.

Untuk melihat informasi koneksi:

  1. Di menu administrasi Drupal, pilih Konfigurasi > Portal Dev > Setelan Aplikasi.

Untuk mengubah konfigurasi:

Cara Anda mengubah konfigurasi bergantung pada penginstalan portal dan versi portal:

  • Penginstalan portal berbasis cloud versi 15.01.06 dan yang lebih baru: Anda harus mengajukan permintaan ke Dukungan Apigee Edge untuk mengubah informasi koneksi. Misalnya, jika Anda ingin mengubah nama organisasi.
  • Penginstalan lokal dan portal berbasis cloud sebelum versi 15.01.06: Ubah informasi koneksi seperti yang dijelaskan di bawah:
  1. Di menu administrasi Drupal, pilih Konfigurasi > Setelan Portal Dev.
  2. Masukkan nama organisasi Anda di Management API Organization.
  3. Masukkan URL endpoint Edge di URL Endpoint Management API.
  4. Masukkan kredensial administrator organisasi di Pengguna yang Diautentikasi Endpoint dan Sandi Pengguna yang Diautentikasi.
  5. Pilih Uji Koneksi untuk memastikan koneksi berhasil.
  6. Pilih Save Configuration.

Memastikan akses ke Edge dari portal

Karena sebagian besar informasi yang digunakan oleh portal disimpan di Edge, Anda harus memastikan bahwa portal dapat mengakses Edge. Portal memulai komunikasi dengan Edge dengan membuat permintaan REST melalui HTTP dan HTTPS. Misalnya, saat developer mendaftarkan aplikasi baru di portal, portal akan membuat permintaan ke Edge untuk mengirim informasi tentang aplikasi ke Edge.

Edge dan portal dapat di-deploy di cloud atau di lokal, dan Anda dapat mencampur jenis deployment. Misalnya, Anda dapat men-deploy keduanya di cloud, keduanya di lokal, atau men-deploy satu di cloud dan satu di lokal:

  • Jika portal dan Edge di-deploy oleh Apigee di cloud, maka tidak akan ada masalah dalam membuat permintaan dari portal ke Edge.
  • Jika men-deploy portal di lokal, Anda harus memastikan bahwa portal dapat membuat permintaan ke Edge, terlepas dari apakah Edge di-deploy di cloud atau di lokal.
  • Jika men-deploy Edge di premis, Anda harus memastikan bahwa portal memiliki akses ke Edge. Artinya, server Edge Anda harus menerima permintaan dari portal, terlepas dari apakah portal di-deploy di cloud atau di lokal.

Video: Tonton video singkat untuk mempelajari lebih lanjut cara portal developer berkomunikasi dengan Apigee Edge dan memastikan koneksi berfungsi.

Mengelola aplikasi dan kunci API dari portal

Saat developer menyelesaikan proses pendaftaran aplikasi di portal, portal akan mengirimkan informasi tentang aplikasi ke Edge, termasuk nama aplikasi dan produk API yang terkait dengan aplikasi.

Jika Edge berhasil mendaftarkan aplikasi, Edge akan menampilkan satu kunci API ke portal. Developer kemudian menggunakan kunci API tersebut untuk mengakses produk API yang terkait dengan aplikasi.

Tidak ada informasi tentang aplikasi dan kunci API yang benar-benar disimpan di portal. Sebagai gantinya, semua informasi tersebut disimpan di Edge. Oleh karena itu, setiap kali developer menggunakan portal untuk melihat informasi tentang aplikasi, portal akan membuat permintaan ke Edge untuk mengakses informasi tersebut. Setiap kali developer mengubah aplikasi, portal akan otomatis mengirimkan perubahan tersebut ke Edge.

Misalnya, developer login ke portal dan membuka halaman Aplikasi Saya. Untuk mengisi halaman Aplikasi Saya, portal membuat permintaan ke Edge untuk mengambil informasi tentang aplikasi dan kunci API developer. Informasi tersebut kemudian muncul di halaman My Apps developer di portal:

Jika developer kemudian menambahkan, menghapus, atau mengubah aplikasi, portal akan mengirimkan perubahan tersebut ke Edge.

Karena semua informasi tentang aplikasi dan kunci API disimpan di Edge, administrator Edge dapat memanipulasi informasi tersebut menggunakan UI Edge. Misalnya, administrator dapat:

  • Menambahkan, menghapus, atau mengubah aplikasi developer
  • Mencabut atau menyetujui kunci API untuk aplikasi

Yang ditampilkan di bawah adalah aplikasi yang sama, 'Aplikasi Cuaca Saya', seperti yang terlihat oleh administrator di UI Edge:

Mengelola developer dari portal

Saat developer mendaftar sebagai pengguna portal baru, developer akan dibuat di Edge dan di portal. Oleh karena itu, tidak seperti aplikasi dan kunci API, informasi tentang developer sebenarnya disimpan di Edge dan portal.

Informasi developer yang disimpan di Edge mencakup:

  • Nama depan
  • Nama belakang
  • Alamat email
  • Informasi tambahan opsional yang dikirim dari portal

Portal ini menyimpan informasi yang sama dengan Edge, tetapi juga menyimpan informasi tambahan, termasuk:

  • Sandi portal
  • Status akun portal: aktif atau diblokir
  • Peran portal: pengguna yang diautentikasi, administrator, lainnya
  • Izin berbasis peran: menentukan tindakan yang diizinkan developer untuk dilakukan di portal

Saat developer login ke portal, portal tersebut yang bertanggung jawab untuk mengautentikasi developer dan menerapkan izin berbasis peran.

Karena portal menyimpan semua informasi tentang developer, anggap portal sebagai sistem pencatatan untuk informasi developer, bukan Edge. Saat developer mengubah informasinya di portal, informasi tersebut akan disimpan di portal dan, jika berlaku, dikirim ke Edge. Misalnya, jika developer mengubah nama depannya, informasi tersebut akan dikirim ke Edge. Namun, jika developer mengubah sandinya, informasi tersebut hanya disimpan secara lokal di portal.

Untuk informasi selengkapnya, lihat Menambahkan dan mengelola akun pengguna.

Menyinkronkan developer aplikasi antara portal dan Edge

Edge tidak memulai komunikasi dengan portal. Jika Anda, sebagai administrator Edge, memanipulasi informasi tentang developer di UI Edge, tidak ada jaminan kapan informasi tersebut akan didorong ke portal. Oleh karena itu, gunakan fitur administrasi portal untuk membuat, mengubah, dan menghapus developer, bukan Edge.

Administrator portal dapat memaksa sinkronisasi antara portal dan Edge untuk mendownload informasi ke portal dari Edge. Namun, jika Anda hanya mengubah developer di portal, bukan di Edge, Anda tidak perlu melakukan sinkronisasi ini. Selain itu, karena Edge tidak mengizinkan Anda menetapkan sandi saat membuat developer, setiap developer yang dibuat di Edge akan memiliki sandi portal yang ditetapkan ke nilai acak. Oleh karena itu, developer harus melalui proses pemulihan sandi sebelum dapat login ke portal.

Untuk menyinkronkan portal dengan developer aplikasi di Edge

:
  • Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  • Pilih Orang di menu administrasi Drupal.
  • Pilih tombol Sinkronisasi Developer Portal Dev di bagian atas halaman untuk menyinkronkan dengan developer aplikasi di Edge.