Memahami organisasi

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Organisasi adalah container level teratas di Apigee. Project ini berisi semua proxy API Anda dan resource terkait. Meskipun bagian lain dari topik ini membahas lebih mendalam tentang organisasi, berikut beberapa poin praktis:

  • Setelah dibuat, Anda tidak dapat mengganti nama organisasi.
  • Nama organisasi Anda dapat dilihat di URL UI Apigee. Contoh:
    https://apigee.google.com/organizations/ORG_ID
  • Saat Anda melakukan panggilan dengan Apigee API, organisasi adalah bagian wajib dari jalur di sebagian besar panggilan. Misalnya, permintaan curl berikut menampilkan daftar semua proxy API di organisasi menggunakan API organisasi:
    curl https://apigee.googleapis.com/v1/organizations/YOUR_ORG_ID/apis
  • Meskipun Anda mungkin hanya membuat satu organisasi, Anda dapat menjadi bagian dari organisasi lain sebagai pengguna atau administrator dengan izin khusus. Anda dapat beralih ke organisasi lain, seperti yang dijelaskan dalam Beralih antar-organisasi.
  • Organisasi Apigee tidak sama dengan organisasi Google Cloud. Jika ada kemungkinan ambiguitas, dokumen ini menentukan bahwa "organisasi" adalah organisasi Apigee.

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 Langganan atau model penetapan harga Apigee Bayar sesuai penggunaan.

  • Evaluasi: Organisasi layanan mandiri sementara untuk menguji Apigee. Organisasi yang juga dikenal sebagai organisasi evaluasi ini memiliki batas waktu serta tidak memiliki skalabilitas dan fleksibilitas organisasi produksi.

Lihat juga Membandingkan organisasi eval dan berbayar.

Masa pakai org eval

Organisasi evaluator memiliki masa aktif terbatas:

  1. Hari ke-0: Buat organisasi eval.
  2. Hari ke-30: Google mengirimkan peringatan notifikasi email tentang akhir masa berlaku evaluasi mendatang.
  3. Hari ke-60: Google menghapus organisasi eval.

Komponen organisasi

Gambar berikut menunjukkan komponen utama model organisasi Apigee. Model ini mendefinisikan hubungan API, produk API, aplikasi, dan developer aplikasi Anda dalam Apigee.

Diagram hierarkis yang menunjukkan organisasi sebagai root deployment Apigee.

Model ini tidak menunjukkan 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 hanya dimiliki oleh satu project Google Cloud, dan satu project dapat berisi maksimal satu organisasi. Suatu organisasi berisi lingkungan, proxy API, produk API, paket API, aplikasi, dan pengguna.

Pemegang akun tidak terbatas untuk satu organisasi. Beberapa pemegang akun dapat menentukan atau menjadi anggota beberapa organisasi yang mendukung berbagai komunitas developer aplikasi.

Lingkungan dan grup lingkungan

Lingkungan adalah lingkungan software yang terisolasi, dalam organisasi, tempat Anda deploy proxy API. Anda dapat membuat beberapa lingkungan dalam sebuah organisasi.

Grup lingkungan adalah sekumpulan 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 di grup lingkungan.

Proxy API

Proxy API adalah antarmuka antara permintaan masuk dan layanan backend. Entity proxy berisi petunjuk dan kebijakan yang dijalankan Apigee saat memproses permintaan dari klien dan respons dari backend.

Produk API

Entity untuk memublikasikan API. Produk API dipublikasikan ke portal developer untuk digunakan oleh developer eksternal. Produk API menyajikan 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. Satu jenis metadata yang umum digunakan dapat menentukan paket layanan, yang dapat menentukan batas akses pada panggilan API, menetapkan persyaratan keamanan, memungkinkan pemantauan dan analisis, serta menyediakan fitur tambahan.

Apigee mengumpulkan data untuk analisis produk API.

Penyedia API

Orang atau entitas yang membuat serta mengelola produk dan proxy API. Developer aplikasi klien mengakses API yang dipublikasikan ini.

Developer Aplikasi

Sebuah organisasi berisi satu atau beberapa developer yang membangun 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 bersifat internal untuk perusahaan Anda, partner, atau developer eksternal yang mungkin membayar atau tidak membayar untuk mengakses API Anda. Anda dapat menganggap developer sebagai pelanggan yang menggunakan API Anda.

Developer harus terdaftar di organisasi Anda agar dapat mendaftarkan aplikasi dan menerima kunci API untuk mengakses API Anda. Sebagai penyedia API, Anda dapat menentukan cara menambahkan, mengupdate, atau menghapus developer di organisasi Anda. Anda dapat menambahkannya secara manual melalui UI, membuat portal developer untuk mendaftarkannya melalui situs, atau menentukan 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 memerlukan pemeriksaan kredensial (seperti kunci API atau token OAuth) harus terlebih dahulu membuat pendaftaran Aplikasi dengan organisasi Anda. Pendaftaran aplikasi memberikan kunci API, pasangan kunci/rahasia, atau kredensial lain kepada developer yang harus digunakan saat aplikasi klien memanggil API Anda.

Karena semua aplikasi terdaftar di organisasi, Anda dapat menggunakan Apigee untuk memantau dan mengumpulkan informasi analisis di 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 bercabang dua, OAuth bercabang tiga, dan lainnya.

Jika penyedia API menetapkan verifikasi kunci API sebagai mekanisme otorisasi, aplikasi klien harus meneruskan kunci API bersama setiap permintaan ke API Anda. Jika kunci tersebut valid, Apigee akan mengizinkan permintaan. Atau, jika penyedia API menentukan verifikasi token OAuth sebagai mekanisme otorisasi, aplikasi klien harus mendapatkan token OAuth terlebih dahulu, lalu meneruskan token tersebut bersama setiap permintaan ke API Anda. Jika token tersebut valid, Apigee akan mengizinkan permintaan tersebut. Skema otorisasi kustom lainnya juga dapat dilakukan.

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 aplikasinya sendiri melalui portal developer, developer dapat mengambil kunci atau kredensial yang diperlukan untuk mengakses API Anda melalui pengalaman layanan mandiri yang mudah digunakan.

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 dari aplikasi developer masih ada di organisasi Anda). Atau, Anda dapat menentukan masa habis berlaku pada kunci sehingga developer harus me-refresh kunci setelah waktu tertentu.

Pengguna Apigee

Pengguna Apigee membentuk tim API organisasi, yang dapat mencakup orang-orang seperti administrator, proxy API dan pembuat produk API, atau pengguna yang memantau analisis dan statistik lainnya. Pengguna akhir adalah orang-orang yang menggunakan aplikasi yang dibuat oleh developer Apigee. Umumnya, dokumentasi ini menggunakan istilah "pengguna" untuk merujuk ke pengguna Apigee.

Administrator dapat menambahkan pengguna ke organisasi.

Pengguna yang berbeda dapat memiliki peran dan hak akses yang berbeda. Misalnya, tentukan beberapa pengguna sebagai Administrator Organisasi dan Administrator Operasi dengan hak istimewa untuk mengubah organisasi dan komponennya. Tentukan pengguna lain yang memiliki izin untuk membuat proxy API dan produk API, tetapi tidak memiliki hak istimewa untuk mengubah pengguna lain.

Pengguna dapat menjadi anggota dari beberapa organisasi. Misalnya, perusahaan Anda mungkin menentukan beberapa organisasi di Apigee untuk mendukung berbagai komunitas developer, meskipun secara internal, orang yang sama membangun semua proxy API dan produk API, sehingga menjadi anggota dari semua organisasi Anda.

Anda tidak perlu membuat organisasi Apigee untuk menjadi pengguna. Administrator dapat menambahkan Anda ke organisasi yang sudah ada.

Semua pengguna login ke Apigee di sini: UI Apigee.

Hak

Hak organisasi bergantung pada apakah organisasi berbayar menggunakan model penetapan harga Langganan atau Bayar sesuai penggunaan.

Hak langganan

Organisasi: Hak organisasi dinyatakan dalam unit. Saat mendapatkan hak unit organisasi, Anda dapat menggunakannya untuk mengaktifkan satu organisasi baru di region mana pun yang Anda inginkan, atau untuk memperluas organisasi yang ada ke satu region baru (menggunakan perluasan nama domain). Untuk tujuan hak, organisasi di region N menggunakan N unit organisasi. Misalnya, jika membeli empat unit organisasi baru, Anda dapat:

  • memperluas organisasi yang ada menjadi empat {i>region<i} baru,
  • atau memperluas masing-masing dari 2 organisasi yang ada ke dalam dua wilayah baru,
  • atau membuat empat organisasi baru, masing-masing tersedia di satu wilayah.

Total hak unit organisasi Anda adalah gabungan dari tingkat Langganan Anda ditambah Paket Organisasi yang relevan.

Lingkungan: Hak lingkungan juga dinyatakan dalam unit. Perangkat ini independen dari hak organisasi dan berperilaku secara berbeda. Terdapat proses dua langkah untuk menggunakan hak unit lingkungan: pertama, Anda membuat lingkungan, lalu melampirkan lingkungan tersebut ke organisasi. Lingkungan diperhitungkan terhadap hak unit lingkungan Anda saat lingkungan telah dilampirkan ke organisasi.

Penggunaan unit lingkungan dihitung sebagai jumlah lingkungan yang digunakan di semua organisasi dan setiap region. Dengan kata lain, lingkungan yang disediakan di dua region untuk satu organisasi akan menggunakan dua unit lingkungan dari hak Anda.

Hak total unit lingkungan Anda adalah gabungan dari hak yang diberikan dalam tingkat Langganan Anda ditambah hak tambahan yang diperoleh melalui Paket Lingkungan atau Organisasi. Dengan membeli Paket Organisasi, Anda akan mendapatkan satu unit organisasi dan sejumlah unit lingkungan. Hak unit lingkungan apa pun yang ditambahkan melalui Paket Organisasi tidak bergantung pada organisasi apa pun yang Anda buat atau perluas. Hak unit lingkungan yang ditambahkan melalui Paket Organisasi akan ditambahkan ke total hak unit lingkungan Anda. Untuk menambahkan lebih banyak unit lingkungan tanpa membeli unit organisasi tambahan, Anda dapat membeli Paket Lingkungan.

Untuk mengetahui detail selengkapnya, lihat Hak langganan.

Hak bayar sesuai penggunaan

Organisasi: Model penetapan harga Bayar sesuai penggunaan memberikan hak kepada pemegang akun untuk satu organisasi.

Lingkungan: Hak lingkungan tidak bergantung pada hak organisasi. Perilaku perangkat ini juga berbeda dengan hak organisasi karena terdapat proses dua langkah untuk menggunakannya: pertama, Anda membuat lingkungan, lalu melampirkan lingkungan tersebut ke organisasi. Lingkungan tidak diperhitungkan terhadap batas hak Anda hingga batas tersebut dilampirkan ke organisasi.

Dengan kata lain, jumlah lingkungan yang diperhitungkan terhadap hak Anda adalah jumlah lingkungan yang telah dikaitkan ke organisasi.

Model harga Bayar sesuai penggunaan mencakup hak 85 lingkungan di semua region.

Untuk detail selengkapnya, lihat Hak bayar sesuai penggunaan.