Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Organisasi adalah container level teratas di Apigee Edge. Aplikasi ini berisi semua proxy API Anda dan sumber daya terkait. Sementara bagian lain topik ini membahas lebih jauh tentang organisasi, berikut beberapa poin praktisnya:
- Secara default, nama organisasi ada di URL yang digunakan untuk memanggil proxy API Anda, seperti
yang dijelaskan dalam Tentang host virtual.
Contoh:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- Nama organisasi Anda ada di URL UI pengelolaan Edge. Misalnya, URL berikut menampilkan proxy API untuk organisasi
docs:
- Meskipun Anda mungkin hanya membuat satu organisasi, Anda dapat menjadi anggota organisasi lain sebagai pengguna atau administrator dengan izin akses tertentu. Di UI pengelolaan Edge, jika Anda termasuk lebih dari satu organisasi, Anda dapat beralih ke organisasi yang berbeda seperti yang dijelaskan di Beralih antarorganisasi.
- Saat melakukan panggilan dengan API pengelolaan sebagai pengguna di Administrator Organisasi
peran, organisasi adalah bagian jalur
yang wajib dalam sebagian besar panggilan. Misalnya,
permintaan cURL API pengelolaan menampilkan daftar semua proxy API di organisasi:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
Video: Tonton video singkat untuk mempelajari cara organisasi mendukung arsitektur multi-tenancy untuk pengelolaan API.
Komponen organisasi
Saat Anda membuat akun Edge, Edge secara otomatis membuat organisasi untuk Anda. Satu kali Anda dapat menambahkan pengguna ke organisasi, membuat proxy API dan produk API, serta mendaftarkan developer dan aplikasi.
Gambar berikut menunjukkan komponen utama model organisasi Edge. Ini mendefinisikan bagaimana API, produk API, aplikasi, dan developer aplikasi Anda saling terkait dalam Edge.
Model ini tidak menampilkan semua fitur Apigee Edge. Jika Anda menggunakan monetisasi, maka model akan memiliki komponen tambahan. Untuk informasi selengkapnya, lihat Ringkasan monetisasi. Lihat Mengelola perusahaan dan developer untuk mendapatkan informasi tentang cara mengelola perusahaan dan developer dengan monetisasi.
Nama organisasi
Nama organisasi:
- Organisasi evaluasi:
username-eval - Organisasi berbayar: Buatan pengguna pada saat penyediaan awal
Setelah dibuat, Anda tidak dapat mengganti nama organisasi.
Nama organisasi menjadi bagian dari URL untuk proxy API Anda dan bagian dari URL saat membuat permintaan ke API pengelolaan Edge. Misalnya, URL standar yang digunakan untuk mengakses API {i>proxy<i} memiliki bentuk:
http://org-name-env.apigee.net/v1/weather/forecastrss
dalam hal ini:
- org-name adalah nama organisasi Anda.
- env adalah lingkungan deployment proxy API, yang berupa pengujian atau prod.
Contoh:
http://myorg-test.apigee.net/v1/weather/forecastrss
Komponen organisasi
Tabel berikut menjelaskan komponen model organisasi secara lebih mendetail:
| Komponen | Deskripsi |
|---|---|
|
Organisasi |
Setiap akun Apigee dipetakan ke satu atau beberapa organisasi di Apigee Edge. Tujuan organisasi berisi representasi dari semua komponen termasuk proxy API, API, produk, paket API, aplikasi, dan developer. Pemegang akun tidak terbatas pada satu organisasi. Beberapa pemegang akun mungkin menentukan atau menjadi anggota beberapa organisasi yang mendukung developer aplikasi yang berbeda komunitas. |
| Lingkungan | Konteks eksekusi runtime untuk proxy API di organisasi. Lihat bagian di bawah ini untuk informasi selengkapnya tentang lingkungan. |
|
Pengguna |
Dalam suatu organisasi, di mana orang yang membuat akun secara otomatis administrator, Anda dapat membuat lebih banyak pengguna. Pengguna membentuk tim API organisasi, yang dapat mencakup orang-orang seperti administrator, proxy API, dan pembuat produk API, pengguna yang memantau analitik dan statistik lainnya, dan banyak lagi. Pengguna yang berbeda dapat memiliki peran dan hak istimewa akses yang berbeda. Misalnya, tentukan beberapa pengguna sebagai Administrator Organisasi dan Administrator Operasi yang memiliki hak istimewa memodifikasi organisasi dan komponennya. Tentukan pengguna lain yang memiliki izin untuk membuat proxy API dan produk API, tetapi tanpa hak istimewa untuk mengubah pelanggan. Pengguna dapat menjadi anggota di beberapa organisasi. Misalnya, perusahaan Anda mungkin mendefinisikan beberapa organisasi di Apigee Edge untuk mendukung berbagai komunitas developer. Namun secara internal, orang-orang yang sama membangun semua {i>proxy<i} API dan produk API serta oleh karena itu anggota dari semua organisasi Anda. Anda tidak perlu membuat akun Apigee—artinya, buat Apigee organisasi—menjadi pengguna. Administrator dapat menambahkan Anda ke organisasi/pengaturan. Semua pengguna login ke Apigee Edge di sini: https://enterprise.apigee.com. |
|
Proxy API |
Pengguna di organisasi membuat satu atau beberapa proxy API. Proxy API mendefinisikan sebuah pemetaan endpoint HTTP yang tersedia secara publik ke layanan backend. Proxy API juga dapat dikonfigurasi untuk mencakup keamanan (seperti OAuth), melakukan transformasi pesan (seperti sebagai XML ke JSON), membatasi traffic ke layanan backend, dan melakukan operasi berharga lainnya terkait permintaan, respons, dan info layanan. Edge mengumpulkan data untuk analisis terkait proxy API. |
|
Produk API |
Pengguna di sebuah organisasi membuat satu atau beberapa produk API, dengan produk API paket proxy API yang digabungkan dengan paket layanan. Paket layanan tersebut dapat mengatur akses membatasi proxy API, memberikan keamanan, mengizinkan pemantauan dan analisis, fitur tambahan. Edge mengumpulkan data untuk analisis tentang produk API. |
|
Developer |
Sebuah organisasi berisi satu atau beberapa developer yang membangun aplikasi yang menggunakan API (yang disusun menjadi produk API) yang ditentukan oleh organisasi Anda. Developer menggunakan API tetapi tidak dapat membuat API atau melakukan tindakan lain dalam organisasi. Developer dapat berasal dari internal perusahaan Anda, mereka dapat menjadi partner, atau dapat menjadi developer eksternal yang membayar untuk mengakses API Anda. Pengembang harus terdaftar di organisasi Anda sebelum mereka dapat mendaftarkan aplikasi dan menerima kunci API untuk mengakses API Anda. Sebagai penyedia API, Anda dapat menentukan cara menambahkan, memperbarui, atau menghapus developer di organisasi Anda. Anda dapat menambahkannya secara manual melalui UI pengelolaan Edge, buat portal developer untuk mendaftarkannya melalui situs Anda, atau menentukan mekanisme pendaftaran Anda sendiri dengan menggunakan pengelolaan Edge Compute Engine API. Pengembang tidak diharuskan memiliki akun di Edge, dan sebagian besar pengembang tidak dapat melakukannya perlu mengetahui apa pun tentang Edge. Jika pengembang memiliki akun di Edge, umumnya sebagai pengguna di organisasi lain, atau untuk menggunakan Layanan Edge API. |
|
Aplikasi |
Developer membuat satu atau beberapa aplikasi klien yang menggunakan API Anda. Developer harus mendaftarkan aplikasinya ke organisasi Anda. Aplikasi di Edge adalah aplikasi aktual dari developer yang memberi developer kunci API untuk diteruskan ke setiap permintaan ke API Anda. Karena semua aplikasi terdaftar di organisasi, Anda dapat menggunakan Edge untuk memantau dan mengumpulkan informasi analisis tentang aplikasi dan penggunaan API Anda. |
|
Kunci API/token OAuth |
Bergantung pada mekanisme otorisasi yang Anda tentukan untuk API, aplikasi akan meneruskan kunci API beserta setiap permintaan ke API Anda. Jika kunci tersebut valid, permintaan akan diizinkan. Edge mendukung berbagai jenis autentikasi, seperti kunci API sederhana, {i>two-legged OAuth<i}, {i> three-legged OAuth<i}, dan lain-lain. Sebagai penyedia API, Anda harus menentukan cara bagi developer untuk mendaftarkan aplikasi mereka. Penting dengan mendaftarkan aplikasi mereka yang Anda kembalikan kepada pengembang kunci yang diperlukan untuk mengakses Google Cloud Platform. Pada saat pendaftaran aplikasi, developer dapat memilih untuk mengakses satu API satu atau beberapa produk API. Aplikasi developer yang sebenarnya menggunakan kunci yang sama untuk mengakses semua produk API yang terkait dengan aplikasi (representasi terdaftar dari aplikasi developer di Edge). Anda dapat mencabut kunci kapan saja sehingga aplikasi developer tidak lagi memiliki akses ke API Anda (meskipun representasi terdaftar dari aplikasi developer masih ada di organisasi Anda). Atau, Anda dapat menentukan batas waktu pada kunci sehingga pengembang harus memuat ulang kunci setelah waktu tertentu. |
Tentang lingkungan
Lingkungan adalah konteks eksekusi runtime untuk proxy API di organisasi. Anda harus men-deploy proxy API ke lingkungan sebelum dapat diakses. Anda dapat men-deploy API {i>proxy<i} ke satu lingkungan atau ke beberapa lingkungan.
Sebuah organisasi dapat memiliki beberapa lingkungan. Misalnya, Anda dapat menentukan dev,
lingkungan test, dan prod dalam organisasi.
Organisasi menyediakan cakupan untuk beberapa kemampuan Apigee. Misalnya, peta nilai kunci (KVM) data dapat tersedia di tingkat organisasi, yang berarti bahwa Proxy API di-deploy ke akan mendapatkan data yang sama dari KVM. Beberapa kemampuan, seperti caching, dapat dicakup untuk organisasi, atau ke lingkungan tertentu dalam organisasi. Data analisis Apigee dipartisi berdasarkan kombinasi organisasi dan lingkungan.
Di bawah ini adalah entitas utama yang Anda kelola dalam sebuah organisasi, termasuk entitas utama yang Anda kelola secara global dalam organisasi, dan yang didefinisikan secara khusus untuk suatu lingkungan:
