Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Jika Anda ingin memiliki kontrol lebih besar atas perusahaan dan developer yang berpartisipasi dalam Program API—misalnya, jika Anda ingin membuat perusahaan dan pengembang internal untuk pengujian—Anda dapat membuat perusahaan dan developer secara manual dengan UI pengelolaan dan API.
Pertimbangan utama yang menentukan apakah Anda perlu membuat perusahaan dan developer secara manual adalah apakah developer memerlukan kredensial untuk login ke UI pengelolaan, mengirim kredensial dalam panggilan ke Edge management API, atau login ke portal developer.
- Jika developer monetisasi Anda memerlukan kredensial login untuk mengakses UI atau API Edge, mereka harus memiliki kredensial sendiri Akun administrator Apigee.
- Jika Anda hanya perlu membuat developer pengujian yang tidak memerlukan kredensial (misalnya, jika jika Anda ingin melakukan panggilan API dengan developer pengujian fiktif), tidak ada akun Apigee yang tidak diperlukan.
Mengelola developer aplikasi menggunakan UI
Membuat, mengelola, dan mengaktifkan developer aplikasi menggunakan UI Edge, seperti yang dijelaskan dalam Mengelola developer aplikasi. Setelah developer aplikasi dibuat, Anda dapat menambahkannya ke perusahaan, seperti yang dijelaskan di bagian berikut.
Mengelola perusahaan menggunakan UI
Buat, kelola, dan aktifkan perusahaan, seperti yang dijelaskan di bagian berikut.
Menjelajahi halaman Perusahaan
Akses halaman Perusahaan, seperti yang dijelaskan di bawah.
Edge
Untuk mengakses halaman Companies menggunakan UI Edge:
- Login ke apigee.com/edge.
- Pilih Publikasikan > Monetisasi > Perusahaan di menu navigasi sebelah kiri.
Laman Perusahaan ditampilkan.
Seperti yang disorot dalam gambar, halaman Perusahaan memungkinkan Anda untuk:
- Melihat informasi ringkasan untuk semua perusahaan, termasuk nama perusahaan, ID pendaftaran, jumlah aplikasi dan kunci API terdaftar, jenis penagihan, jumlah developer yang ditetapkan untuk perusahaan, dan status
- Menambahkan perusahaan
- Mengaktifkan atau menonaktifkan perusahaan
- Mengedit perusahaan
- Menghapus perusahaan
- Telusuri daftar perusahaan
Edge Klasik (Private Cloud)
Untuk mengakses halaman Perusahaan menggunakan UI Classic Edge:
- Login ke
http://ms-ip:9000
, dengan ms-ip sebagai Alamat IP atau nama DNS node Server Pengelolaan. - Pilih Publikasikan > Perusahaan di menu navigasi atas.
Laman Perusahaan ditampilkan.
- Lihat daftar perusahaan saat ini
- Mengelola perusahaan. Secara khusus menambahkan, mengaktifkan, mengedit, dan menghapus perusahaan.
- Melihat portal developer yang terhubung (khusus Drupal 7)
Menambahkan perusahaan
Untuk menambahkan perusahaan:
- Akses halaman Perusahaan.
- Klik + Perusahaan.
- Masukkan detail perusahaan.
Kolom wajib diisi meliputi:
- Nama Perusahaan
- Administrator (pengguna yang merupakan perusahaan utama administrator)
- Jenis Penagihan
Bergantung pada konfigurasi penagihan monetisasi, Jenis Penagihan mungkin ditetapkan secara default ke
PREPAID
atauPOSTPAID
. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi jenis penagihan prabayar dan pascabayar menggunakan API. - Menambahkan satu atau beberapa developer ke perusahaan.
- Di bagian Developers, masukkan string di kolom Add Developer untuk menampilkan daftar developer yang cocok dengan string tersebut.
- Pilih developer dari menu drop-down.
- Ulangi untuk menambahkan pengembang lain ke perusahaan.
- Tambahkan satu atau beberapa atribut khusus.
- Di bagian Atribut khusus, klik + Baru.
- Masukkan nama dan nilai atribut khusus.
- Ulangi untuk menambahkan atribut khusus lainnya ke perusahaan.
- Klik Buat perusahaan.
Mengaktifkan dan menonaktifkan perusahaan
Untuk mengaktifkan dan menonaktifkan perusahaan:
- Akses halaman Perusahaan.
- Posisikan kursor ke perusahaan yang ingin Anda aktifkan dan aktifkan di menu tindakan.
Nonaktifkan tombol untuk menonaktifkan perusahaan.
Mengedit perusahaan
Untuk mengedit perusahaan:
- Akses halaman Perusahaan.
- Posisikan kursor di atas perusahaan yang ingin Anda edit dan klik di menu tindakan.
- Perbarui detail perusahaan, sebagaimana diperlukan.
- Klik Perbarui perusahaan untuk menyimpan perubahan.
Menghapus perusahaan
Untuk menghapus perusahaan:
- Akses halaman Perusahaan.
- Arahkan kursor ke perusahaan yang ingin Anda hapus, lalu klik di menu tindakan.
- Klik Delete untuk mengonfirmasi operasi penghapusan.
Mengelola perusahaan dan developer menggunakan API
Cara menggunakan API untuk mengelola perusahaan dan developer dijelaskan di bagian berikut.
Membuat dan memberikan info terbaru kepada perusahaan dan developer menggunakan API
Untuk mengelola perusahaan dan pengembang dengan API pengelolaan Edge API, lihat bagian API berikut:
- Membuat perusahaan
- Membuat developer
Catatan: Konfigurasikan informasi monetisasi saat membuat developer dengan meneruskan atribut khusus. - Tambahkan atau
mengupdate developer perusahaan
Catatan: Anda juga dapat menetapkan peran kepada developer, meskipun tidak wajib. Untuk mendapatkan daftar peran developer, lihat Mengambil peran developer. - Cantumkan konfigurasi monetisasi untuk semua developer atau untuk satu developer
Catatan: Tentukan informasi monetisasi dengan meneruskan atribut khusus saat membuat atau memperbarui developer. Anda dapat melihat atribut khusus monetisasi yang disetel menggunakan API standar (non-monetisasi) untuk mencantumkan semua developer atau satu developer.
Mengelola peran developer menggunakan API
Anda dapat membuat peran menggunakan monetization API. Hal ini memungkinkan Anda menetapkan peran untuk partner. Misalnya, Anda dapat menetapkan peran administrator dan developer aplikasi untuk partner Anda. Peran tersebut kemudian dapat ditetapkan kepada karyawan partner tertentu.
Membuat peran developer
Untuk membuat peran developer, kirim permintaan POST ke
organizations/{org_name}/developer-roles
. Saat mengajukan permintaan, Anda harus
dalam isi permintaan, sebutkan nama dan deskripsi peran serta identifikasi
organisasi/pengaturan. Contoh:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "appDeveloper", "description": "App Developer", "organization": { "id": "{org_name}" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \ -u email:password
Mengambil peran developer
Untuk mendapatkan peran developer, kirimkan permintaan GET ke organisasi/{org_id}/developer-roles. Contoh:
$ curl -H "Accept:application/json" -X GET \ "https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \ -u email:password
Respons akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):
{ "description" : "App Developer", "id" : "appdeveloper", "name" : "appDeveloper", "organization" : { ... } }
Setelan konfigurasi peran developer untuk API
Opsi konfigurasi peran developer berikut diekspos ke API:
Nama | Deskripsi | Default | Wajib? |
---|---|---|---|
name |
Nama peran developer. |
T/A | Ya |
description |
Deskripsi peran developer. |
T/A | Ya |
Mengambil tarif pajak untuk developer menggunakan API
Anda bisa mendapatkan tarif pajak saat ini untuk developer dengan mengajukan permintaan GET ke
organizations/{org_name}/tax-engine
. Saat membuat permintaan, Anda harus menentukan
identifikasi developer sebagai parameter kueri. Contoh:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \ -u email:password
Responsnya akan terlihat seperti ini:
0.09
Melakukan tugas khusus developer lainnya menggunakan API
Banyak tugas terkait monetisasi yang dapat Anda lakukan untuk sebuah organisasi, seperti membuat paket tarif atau membuat ketentuan notifikasi, Anda juga dapat melakukannya untuk developer. Misalnya, Anda dapat membuat rekening bank untuk developer tertentu atau membuat laporan pendapatan untuk developer tertentu.
Tabel berikut mencantumkan tugas khusus developer yang dapat Anda lakukan menggunakan Monetization API. Tabel tersebut juga mencantumkan di mana Anda dapat menemukan petunjuk rinci tentang melakukan untuk menyelesaikan tugas-tugas ini.
Tugas | Lokasi petunjuk {i>find<i} |
---|---|
Lihat persyaratan dan ketentuan yang disetujui oleh developer |
Melihat persyaratan dan ketentuan yang disetujui oleh developer atau perusahaan menggunakan API |
Melihat paket API yang diterima oleh developer |
Melihat paket produk API yang diterima oleh developer atau perusahaan yang menggunakan API |
Buat paket tarif developer | |
Lihat paket tarif yang tersedia untuk developer | |
Lihat paket tarif yang tersedia untuk developer tertentu yang berisi produk |
Melihat paket tarif yang diterima untuk developer yang berisi produk API menggunakan API |
Hanya lihat paket tarif developer yang diterima |
Melihat semua paket tarif yang diterima oleh developer menggunakan API |
Memberikan kredit kepada developer | |
Menetapkan batas kredit untuk developer | |
Melihat batas kredit developer | |
"Tambah saldo" (tambahkan jumlah ke) saldo prabayar developer | |
Melihat saldo prabayar developer | |
Menyiapkan kondisi notifikasi untuk developer | |
Membuat dan melihat definisi laporan untuk developer |