Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Lihat dokumentasi Apigee Edge.
Organisasi adalah penampung tingkat teratas di Apigee. Organisasi Apigee berisi semua proxy API dan resource terkait. Meskipun bagian lain dari topik ini membahas organisasi secara lebih mendalam, berikut beberapa poin praktis:
- Organisasi Apigee berbeda dari dan merupakan anak perusahaan dari organisasi Google Cloud. Saat Anda membuat organisasi untuk Apigee X atau Apigee hybrid, organisasi tersebut akan dipetakan ke tepat satu project Google Cloud, dan organisasi Apigee serta project Google Cloud memiliki nama yang sama. Tidak semua project Google Cloud memiliki organisasi Apigee yang terkait.
- Jika dokumentasi Apigee menggunakan istilah "organisasi", istilah tersebut secara khusus merujuk pada organisasi Apigee. Dokumentasi Apigee menggunakan frasa "organisasi Google Cloud" untuk merujuk pada alternatif tersebut.
- Setelah dibuat, Anda tidak dapat mengganti nama organisasi Apigee.
- Nama organisasi Apigee Anda ditampilkan sebagai project di URL untuk bagian Apigee di Konsol Google Cloud.
Contoh:
https://console.cloud.google.com/apigee/overview?project=ORG_ID
- Saat Anda memanggil panggilan REST ke Apigee API, ID organisasi adalah bagian yang diperlukan dari
jalur. Misalnya, permintaan
curl
berikut menampilkan daftar semua proxy API di organisasi menggunakan organizations API:curl https://apigee.googleapis.com/v1/organizations/ORG_ID/apis
- Meskipun Anda mungkin hanya membuat satu organisasi, Anda dapat diberi otorisasi di organisasi lain sebagai pengguna atau administrator dengan izin tertentu. Di konsol cloud, Anda dapat beralih ke organisasi lain seperti yang dijelaskan dalam Beralih di antara organisasi Anda.
Video: Tonton video singkat untuk mempelajari cara organisasi mendukung arsitektur multi-tenancy untuk pengelolaan API.
Jenis organisasi
Ada dua jenis organisasi:
Berbayar: Organisasi permanen dengan skalabilitas penuh. Juga dikenal sebagai organisasi produksi. Organisasi berbayar mencakup organisasi yang dibuat sebagai bagian dari model harga Apigee Berlangganan atau Bayar sesuai penggunaan.
Evaluasi: Organisasi mandiri sementara untuk menguji Apigee. Terkadang disebut sebagai organisasi evaluasi, organisasi ini memiliki batas waktu dan tidak memiliki skalabilitas serta fleksibilitas organisasi produksi.
Lihat juga Membandingkan organisasi evaluasi dan berbayar.
Masa aktif organisasi evaluasi
Organisasi evaluasi memiliki masa berlaku terbatas:
- Hari ke-0: Membuat organisasi evaluasi.
- Hari ke-30: Google mengirimkan notifikasi email yang memperingatkan Anda tentang masa berlaku yang akan berakhir.
- Hari ke-60: Google menghapus organisasi evaluasi.
Organisasi Apigee dalam hierarki Google Cloud
Diagram berikut menunjukkan hubungan antara organisasi dan lingkungan Apigee, serta project dan folder Google Cloud.
Komponen dalam organisasi
Gambar berikut menunjukkan komponen utama model organisasi Apigee. Model ini menentukan bagaimana API, produk API, aplikasi, dan developer aplikasi Anda saling terkait dalam Apigee.
Model ini tidak menampilkan semua fitur Apigee, tetapi dimaksudkan untuk menunjukkan kepada Anda bahwa organisasi adalah root deployment.
Tabel berikut menjelaskan komponen model organisasi secara lebih mendetail:
Komponen | Deskripsi |
---|---|
Organisasi |
Setiap organisasi Apigee termasuk dalam satu project Google Cloud, dan project dapat berisi maksimal satu organisasi. Organisasi berisi lingkungan, proxy API, produk API, paket API, aplikasi, dan pengguna. Pemegang akun tidak terbatas pada satu organisasi. Beberapa pemegang akun mungkin menentukan atau menjadi anggota beberapa organisasi yang mendukung komunitas developer aplikasi yang berbeda. |
Lingkungan dan grup lingkungan | Lingkungan adalah lingkungan software terisolasi, dalam organisasi, tempat Anda deploy proxy API. Anda dapat membuat beberapa lingkungan di organisasi. Grup lingkungan adalah grup lingkungan dengan satu atau beberapa nama host. Nama host adalah bagian dari URL yang digunakan untuk memanggil proxy API yang di-deploy ke lingkungan mana pun dalam grup lingkungan. |
Proxy API |
Proxy API adalah antarmuka antara permintaan masuk dan layanan backend. Entitas proxy berisi petunjuk dan kebijakan yang dijalankan Apigee saat memproses permintaan dari klien dan respons dari backend. |
Produk API |
Entitas untuk memublikasikan API. Produk API dipublikasikan ke portal developer untuk digunakan oleh developer eksternal. Produk API menampilkan antarmuka untuk mengakses satu atau beberapa API yang dipublikasikan. Antarmuka (yang dapat dijelaskan menggunakan spesifikasi OpenAPI) dapat menyertakan kombinasi dari satu atau beberapa permintaan API yang ditangani oleh satu atau beberapa proxy API. Pengguna di organisasi membuat produk API. Saat melakukannya, mereka dapat melampirkan metadata arbitrer ke setiap Produk API. Salah satu jenis metadata yang umum digunakan dapat menentukan paket layanan, yang dapat menentukan batas akses pada panggilan API, menetapkan persyaratan keamanan, mengizinkan pemantauan dan analisis, serta memberikan fitur tambahan. Apigee mengumpulkan data untuk analisis pada produk API. |
Penyedia API |
Orang atau entitas yang membuat dan mengelola proxy dan produk API. Developer aplikasi klien mengakses API yang dipublikasikan ini. |
Developer Aplikasi |
Organisasi berisi satu atau beberapa developer yang mem-build aplikasi yang menggunakan API (dipublikasikan sebagai 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 dalam perusahaan Anda, dapat berupa partner, atau dapat berupa developer eksternal yang mungkin membayar atau tidak membayar untuk akses ke API Anda. Anda dapat menganggap developer sebagai pelanggan yang menggunakan API Anda. Developer harus terdaftar di organisasi Anda sebelum dapat mendaftarkan aplikasi dan menerima kunci API atau kredensial klien lainnya yang memungkinkan akses ke API Anda. Sebagai penyedia API, Anda dapat menentukan cara menambahkan, memperbarui, atau menghapus developer di organisasi Anda. Anda dapat menambahkannya secara manual melalui UI, membuat portal developer untuk mendaftarkannya melalui situs, atau menentukan dan menerapkan mekanisme pendaftaran Anda sendiri menggunakan Apigee API. |
Aplikasi Apigee (atau Aplikasi) |
Developer Apigee membuat satu atau beberapa aplikasi klien yang menggunakan API Anda. Developer yang membuat aplikasi klien yang memanggil API yang memerlukan pemeriksaan kredensial (seperti kunci API atau token OAuth) harus membuat pendaftaran Aplikasi terlebih dahulu dengan organisasi Anda. Pendaftaran Aplikasi memberi developer kunci API, pasangan kunci/rahasia, atau kredensial lain yang harus digunakan saat aplikasi klien memanggil API Anda. Karena semua aplikasi terdaftar di organisasi Anda, Anda dapat menggunakan Apigee untuk memantau dan mengumpulkan informasi analisis tentang aplikasi dan penggunaan API Anda. |
Komponen tambahan Apigee yang tidak ditampilkan adalah kunci API dan token OAuth.
Apigee mendukung berbagai jenis autentikasi, seperti kunci API sederhana, OAuth dua-kaki, OAuth tiga-kaki, dan lainnya.
Jika penyedia API menentukan verifikasi kunci API sebagai mekanisme otorisasi, aplikasi klien harus meneruskan kunci API dengan setiap permintaan ke API Anda. Jika kunci tersebut valid, Apigee akan mengizinkan permintaan tersebut. Atau, jika penyedia API menentukan verifikasi token OAuth sebagai mekanisme otorisasi, aplikasi klien harus terlebih dahulu mendapatkan token OAuth, lalu meneruskan token tersebut dengan setiap permintaan ke API Anda. Jika token tersebut valid, Apigee akan mengizinkan permintaan. Skema otorisasi kustom lainnya juga dimungkinkan.
Sebagai penyedia API, Anda harus menentukan cara bagi developer untuk mendaftarkan aplikasi mereka. Setiap pendaftaran aplikasi akan memiliki satu atau beberapa kunci atau kredensial yang terkait dengannya. Jika Anda mengizinkan developer mendaftarkan aplikasi mereka sendiri melalui portal developer, developer dapat mengambil kunci atau kredensial yang diperlukan untuk mengakses API Anda, melalui pengalaman mandiri yang praktis.
Pada saat pendaftaran aplikasi, developer dapat memilih untuk mengakses satu produk API atau beberapa produk API. Aplikasi developer menggunakan kunci/kredensial yang sama untuk mengakses semua produk API yang terkait dengan aplikasi.
Anda dapat mencabut kunci kapan saja sehingga aplikasi developer tidak lagi memiliki akses ke API Anda (meskipun representasi terdaftar aplikasi developer masih ada di organisasi Anda). Atau, Anda dapat mencabut developer, dengan demikian semua kredensial untuk aplikasi apa pun yang terdaftar untuk developer tersebut tidak dapat digunakan. Pencabutan dapat diurungkan. Saat Apigee membuat kredensial aplikasi, Anda dapat menentukan masa berlaku sehingga developer harus mendapatkan kunci atau kredensial baru setelah waktu tertentu.
Pengguna Apigee
Pengguna Apigee membentuk tim API organisasi, yang dapat mencakup orang-orang seperti administrator, pembuat proxy API dan produk API, atau pengguna yang memantau analisis dan statistik lainnya. Pengguna akhir adalah orang yang menggunakan aplikasi yang dibuat developer Apigee. Pada umumnya, dokumentasi ini menggunakan istilah "pengguna" untuk merujuk pada pengguna Apigee.
Administrator dapat menambahkan pengguna ke organisasi.
Pengguna yang berbeda dapat memiliki peran dan hak istimewa akses yang berbeda. Misalnya, tentukan beberapa pengguna sebagai Administrator Organisasi dan Administrator Operasi dengan hak istimewa untuk mengubah organisasi dan komponennya, serta 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 mungkin menentukan beberapa organisasi di Apigee untuk mendukung komunitas developer yang berbeda, meskipun secara internal, orang yang sama mem-build semua proxy API dan produk API sehingga menjadi anggota semua organisasi Anda.
Anda tidak perlu membuat organisasi Apigee untuk menjadi pengguna. Administrator dapat menambahkan Anda ke organisasi yang ada.
Semua pengguna login ke Apigee di sini: UI Apigee di konsol Cloud.
Hak dan penagihan
Baik organisasi berbayar menggunakan model harga Langganan atau Bayar sesuai penggunaan, item yang diukur untuk tujuan penagihan adalah: lingkungan, panggilan API, dan deployment proxy.
Paket langganan memungkinkan Anda melakukan prabayar untuk mendapatkan hak, dengan imbalan diskon yang signifikan. Paket langganan cocok untuk volume penggunaan yang lebih tinggi - dengan jumlah lingkungan yang lebih besar, volume panggilan API yang tinggi, atau sejumlah besar proxy API yang dikelola oleh Apigee. Berdasarkan model Bayar sesuai penggunaan, Anda hanya membayar resource yang digunakan, tetapi tidak mendapatkan diskon volume.
Hak langganan
Organisasi |
Anda dapat mengaktifkan Apigee di project Google Cloud mana pun. Tindakan ini akan membuat organisasi Apigee untuk project tersebut. Anda dapat membuat organisasi sebanyak yang Anda inginkan. Sama seperti tidak ada hak atau tagihan yang diperlukan untuk membuat project Google Cloud, tidak ada persyaratan hak untuk membuat organisasi Apigee. |
---|---|
Lingkungan |
Hak untuk Lingkungan dinyatakan dalam unit. Ada proses dua langkah untuk menggunakan hak unit lingkungan: pertama-tama, Anda membuat lingkungan, lalu Anda melampirkan lingkungan tersebut ke organisasi. Lingkungan mengurangi hak unit lingkungan Anda saat lingkungan telah disertakan ke organisasi. Lihat Batas untuk mengetahui jumlah maksimum lingkungan dalam satu organisasi. Anda dapat memilih untuk membuat lingkungan Apigee di satu atau beberapa region Google Cloud yang tersedia. Setiap region tempat lingkungan dipetakan akan menggunakan satu unit lingkungan dari hak Anda. Lingkungan yang disediakan di satu region menggunakan satu unit lingkungan dari hak Anda. Lingkungan yang disediakan di dua region akan menggunakan dua unit lingkungan dari hak Anda. Total penggunaan unit lingkungan adalah gabungan dari jumlah unit lingkungan yang digunakan di semua organisasi. Total hak unit lingkungan Anda adalah jumlah hak yang disediakan di tingkat langganan Anda ditambah hak tambahan yang diperoleh melalui Paket Lingkungan. Google menerapkan hak untuk lingkungan; Anda tidak boleh melebihi batas hak. Jika Anda mencoba membuat lingkungan yang melebihi batas hak Anda, Anda akan menerima error. Anda dapat memperluas hak Anda dengan membeli Paket Lingkungan tambahan. |
Panggilan API |
Google menghitung setiap panggilan API yang diproses oleh Apigee. Total hak panggilan API Anda adalah jumlah hak yang diberikan di tingkat Langganan ditambah hak tambahan yang diperoleh melalui Paket Panggilan. Berdasarkan paket Langganan, Google tidak menerapkan batas hak untuk panggilan API. Jika Anda melebihi hak panggilan API, Apigee akan terus menayangkan panggilan API. Google akan menagih Anda untuk penggunaan yang melebihi hak yang ada. Anda dapat memperluas hak panggilan API kapan saja dengan membeli Paket Panggilan tambahan. |
Deployment Proxy |
Google menghitung setiap proxy API yang Anda deploy. Total hak deployment proxy Anda adalah jumlah hak yang disediakan di tingkat Langganan ditambah hak tambahan yang diperoleh melalui Paket Deployment Proxy. Berdasarkan paket Langganan, Google tidak membatasi deployment proxy untuk hak Anda. Jika Anda men-deploy lebih banyak proxy daripada yang diizinkan oleh hak Anda, sehingga melebihi hak deployment proxy, Apigee akan terus mengizinkan Anda men-deploy proxy baru, dan Apigee akan terus menayangkan panggilan API. Google menagih Anda untuk penggunaan yang melebihi hak yang ada. Anda dapat memperluas hak Deployment Proxy dengan membeli Paket Panggilan tambahan. |
Untuk mengetahui detail selengkapnya, lihat Hak langganan.
Hak istimewa bayar sesuai penggunaan
Organisasi |
Anda dapat mengaktifkan Apigee di project Google Cloud mana pun. Tindakan ini akan membuat organisasi Apigee untuk project tersebut. Anda dapat membuat organisasi sebanyak yang Anda inginkan. Sama seperti tidak ada biaya untuk membuat project Google Cloud, berdasarkan model harga Bayar sesuai penggunaan, tidak ada biaya untuk membuat organisasi Apigee. |
---|---|
Lingkungan |
Anda dapat melampirkan beberapa lingkungan ke organisasi Apigee. Ada proses dua langkah untuk menggunakan lingkungan: pertama-tama, Anda membuat lingkungan, lalu melampirkan lingkungan tersebut ke organisasi. Google menagih Anda untuk lingkungan yang disertakan ke organisasi. Anda dapat membuat hingga 85 lingkungan dalam satu organisasi. Untuk lingkungan multi-region, Google akan menagih Anda untuk setiap region tempat lingkungan tersedia. Anda dapat memilih salah satu region Google Cloud yang tersedia. |
Panggilan API |
Google menghitung setiap panggilan API yang diproses oleh Apigee. Google menagih Anda berdasarkan jumlah panggilan API yang diproses lingkungan Apigee Anda. Tidak ada batasan. Apigee diskalakan secara otomatis dan terus menayangkan panggilan API, bahkan saat beban meningkat. |
Deployment Proxy |
Google menghitung setiap proxy API yang Anda deploy. Google menagih Anda untuk jumlah proxy API yang di-deploy di lingkungan Apigee Anda. |
Untuk mengetahui detail selengkapnya, lihat Hak penggunaan bayar sesuai pemakaian.