Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Organisasi adalah penampung tingkat teratas di Apigee Edge. Direktori ini berisi semua proxy API dan resource terkait. Meskipun bagian lain dalam topik ini membahas organisasi secara lebih mendalam, berikut beberapa poin praktis:
- Secara default, nama organisasi Anda ada di URL yang digunakan untuk memanggil proxy API, 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 hanya membuat satu organisasi, Anda dapat menjadi anggota organisasi lain sebagai pengguna atau administrator dengan izin tertentu. Di UI pengelolaan Edge, jika Anda tergabung dalam lebih dari satu organisasi, Anda dapat beralih ke organisasi lain seperti yang dijelaskan dalam Beralih antar-organisasi.
- Saat Anda melakukan panggilan dengan Management API sebagai pengguna dalam peran Administrator Organisasi, organisasi adalah bagian yang diperlukan dari jalur di sebagian besar panggilan. Misalnya, permintaan cURL Management API berikut menampilkan daftar semua proxy API dalam organisasi:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
Video: Tonton video pendek untuk mempelajari cara organisasi mendukung arsitektur multi-tenant untuk pengelolaan API.
Komponen organisasi
Saat Anda membuat akun Edge, Edge akan otomatis membuat organisasi untuk Anda. Setelah dibuat, 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. Model ini menentukan hubungan antara API, produk API, aplikasi, dan developer aplikasi dalam Edge.
Model ini tidak menampilkan semua fitur Apigee Edge. Jika Anda menggunakan monetisasi, maka model akan memiliki komponen tambahan. Untuk mengetahui informasi selengkapnya, lihat Ringkasan monetisasi. Lihat Mengelola perusahaan dan developer untuk mengetahui informasi tentang cara mengelola perusahaan dan developer dengan monetisasi.
Nama organisasi
Nama organisasi adalah:
- Org evaluasi:
username-eval - Org berbayar: Ditentukan pengguna pada saat penyediaan awal
Setelah dibuat, Anda tidak dapat mengganti nama organisasi.
Nama organisasi menjadi bagian dari URL ke proxy API Anda dan bagian dari URL saat membuat permintaan ke Edge Management API. Misalnya, URL umum yang digunakan untuk mengakses proxy API memiliki bentuk:
http://org-name-env.apigee.net/v1/weather/forecastrss
dengan:
- org-name adalah nama organisasi Anda.
- env adalah lingkungan deployment proxy API, yang berupa test 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. Organisasi berisi representasi semua komponen, termasuk proxy API, produk API, paket API, aplikasi, dan developer. Pemegang akun tidak terbatas pada satu organisasi. Beberapa pemegang akun dapat menentukan atau menjadi anggota beberapa organisasi yang mendukung komunitas developer aplikasi yang berbeda. |
| Lingkungan | Konteks eksekusi runtime untuk Proxy API dalam organisasi. Lihat bagian di bawah untuk mengetahui informasi selengkapnya tentang lingkungan. |
|
Pengguna |
Dalam organisasi, tempat orang yang membuat akun secara otomatis menjadi administrator, Anda dapat membuat lebih banyak pengguna. Pengguna membentuk tim API organisasi, yang dapat mencakup orang-orang seperti administrator, pembuat proxy API dan produk API, pengguna yang memantau analisis dan statistik lainnya, serta orang lain. Pengguna yang berbeda dapat memiliki peran dan hak istimewa akses yang berbeda. Misalnya, tetapkan beberapa pengguna sebagai Administrator Organisasi dan Administrator Operasi dengan hak istimewa untuk mengubah organisasi dan komponennya. Tentukan pengguna lain dengan izin untuk membuat proxy API dan produk API, tetapi tanpa hak istimewa untuk mengubah pengguna lain. Pengguna dapat menjadi anggota beberapa organisasi. Misalnya, perusahaan Anda dapat menentukan beberapa organisasi di Apigee Edge untuk mendukung komunitas developer yang berbeda. Namun, secara internal, orang yang sama membangun semua proxy API dan produk API serta merupakan anggota semua organisasi Anda. Anda tidak harus membuat akun Apigee—yaitu, membuat organisasi Apigee—untuk menjadi pengguna. Administrator dapat menambahkan Anda ke organisasi yang sudah ada. 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 menentukan pemetaan endpoint HTTP yang tersedia secara publik ke layanan backend. Proxy API juga dapat dikonfigurasi untuk menyertakan keamanan (seperti OAuth), melakukan transformasi pesan (seperti XML ke JSON), membatasi traffic ke layanan backend, dan melakukan operasi berharga lainnya pada permintaan, respons, dan dengan panggilan layanan. Edge mengumpulkan data untuk analisis pada proxy API. |
|
Produk API |
Pengguna dalam organisasi membuat satu atau beberapa produk API, dengan produk API adalah paket proxy API yang digabungkan dengan paket layanan. Paket layanan tersebut dapat menetapkan batas akses pada proxy API, memberikan keamanan, memungkinkan pemantauan dan analisis, serta menyediakan fitur tambahan. Edge mengumpulkan data untuk analisis pada produk API. |
|
Developer |
Organisasi berisi satu atau beberapa developer yang membangun aplikasi yang menggunakan API (yang dikumpulkan ke dalam produk API) yang ditentukan oleh organisasi Anda. Developer menggunakan API tetapi tidak dapat membuat API atau melakukan tindakan lain di organisasi. Developer dapat berasal dari internal perusahaan Anda, partner, atau developer eksternal yang membayar untuk mendapatkan akses ke API Anda. Developer harus terdaftar di organisasi Anda sebelum dapat mendaftarkan aplikasi dan menerima kunci API untuk mengakses API Anda. Sebagai penyedia API, Anda yang menentukan cara menambahkan, memperbarui, atau menghapus developer di organisasi Anda. Anda dapat menambahkannya secara manual melalui UI pengelolaan Edge, membuat portal developer untuk mendaftarkannya melalui situs, atau menentukan mekanisme pendaftaran Anda sendiri dengan menggunakan Edge Management API. Developer tidak diwajibkan untuk memiliki akun di Edge, dan sebagian besar developer tidak perlu mengetahui apa pun tentang Edge. Jika developer memiliki akun di Edge, biasanya akun tersebut adalah akun pengguna di organisasi lain, atau digunakan untuk menggunakan Layanan API Edge. |
|
Aplikasi |
Developer membuat satu atau beberapa aplikasi klien yang menggunakan API Anda. Developer harus mendaftarkan aplikasi mereka ke organisasi Anda. Aplikasi di Edge adalah representasi aplikasi sebenarnya developer yang memberi developer kunci API untuk diteruskan dengan setiap permintaan ke API Anda. Karena semua aplikasi terdaftar di organisasi Anda, Anda dapat menggunakan Edge untuk memantau dan mengumpulkan informasi analisis tentang aplikasi dan penggunaannya atas API Anda. |
|
Kunci API/token OAuth |
Bergantung pada mekanisme otorisasi yang Anda tentukan untuk API, aplikasi akan meneruskan kunci API bersama dengan setiap permintaan ke API Anda. Jika kunci tersebut valid, permintaan akan diizinkan. Edge mendukung berbagai jenis autentikasi, seperti kunci API sederhana, OAuth dua kaki, OAuth tiga kaki, dan lainnya. Sebagai penyedia API, Anda harus menentukan cara bagi developer untuk mendaftarkan aplikasi mereka. Anda dapat mengembalikan kunci yang diperlukan untuk mengakses API Anda kepada developer dengan mendaftarkan aplikasi mereka. Pada saat pendaftaran aplikasi, developer dapat memilih untuk mengakses satu produk API atau beberapa produk API. Aplikasi sebenarnya developer menggunakan kunci yang sama untuk mengakses semua produk API yang terkait dengan aplikasi (representasi terdaftar dari aplikasi developer di Edge). Kapan saja, Anda dapat mencabut kunci sehingga aplikasi developer tidak lagi memiliki akses ke API Anda (meskipun representasi terdaftar aplikasi developer masih ada di organisasi Anda). Atau, Anda dapat menentukan batas waktu pada kunci sehingga developer harus memperbarui kunci setelah waktu tertentu. |
Tentang lingkungan
Lingkungan adalah konteks eksekusi runtime untuk Proxy API dalam organisasi. Anda harus men-deploy proxy API ke lingkungan sebelum dapat diakses. Anda dapat men-deploy proxy API ke satu lingkungan atau ke beberapa lingkungan.
Organisasi dapat berisi beberapa lingkungan. Misalnya, Anda dapat menentukan lingkungan dev,
test, dan prod dalam organisasi.
Organisasi menyediakan cakupan untuk beberapa kemampuan Apigee. Misalnya, data peta nilai kunci (KVM) dapat tersedia di tingkat organisasi, yang berarti bahwa Proxy API yang di-deploy ke lingkungan mana pun akan mendapatkan data yang sama dari KVM. Beberapa kemampuan, seperti caching, dapat dicakup ke 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 organisasi, termasuk yang ditentukan secara global dalam organisasi, dan yang ditentukan secara khusus untuk lingkungan:
