Memahami organisasi

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Organisasi adalah container level teratas di Apigee Edge. File ini berisi semua proxy API Anda dan resource terkait. Meskipun bagian selanjutnya dari topik ini membahas organisasi secara lebih mendalam, berikut beberapa poin praktisnya:

  • Secara default, nama organisasi Anda dicantumkan 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 tercantum di URL UI pengelolaan Edge. Misalnya, URL berikut menampilkan proxy API untuk organisasi docs:

    Pada URL apigee.com/organizations/docs/proxies, /docs/ dilingkari.

  • Meskipun Anda mungkin hanya membuat satu organisasi, Anda dapat menjadi anggota organisasi lain sebagai pengguna atau administrator dengan izin khusus. Di UI pengelolaan Edge, jika Anda memiliki lebih dari satu organisasi, Anda dapat beralih ke organisasi lain seperti yang dijelaskan dalam Beralih antar-organisasi.

  • Saat Anda melakukan panggilan dengan API pengelolaan sebagai pengguna dalam peran Administrator Organisasi, organisasi adalah bagian wajib dari jalur di sebagian besar panggilan. Misalnya, permintaan cURL API pengelolaan berikut 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 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 API, produk API, aplikasi, dan developer aplikasi Anda dalam Edge.

Diagram alur menunjukkan hubungan antara lingkungan, pengguna, produk API, dan developer dengan
    aplikasi, kunci API/token OAuth, dan proxy API.

Model ini tidak menampilkan semua fitur Apigee Edge. Jika Anda menggunakan monetisasi, model akan memiliki komponen tambahan. Untuk informasi selengkapnya, baca Ringkasan monetisasi. Baca Mengelola perusahaan dan developer untuk mengetahui informasi tentang cara mengelola perusahaan dan developer dengan monetisasi.

Nama organisasi

Nama organisasinya adalah:

  • Organisasi evaluasi: username-eval
  • Organisasi 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 biasa yang digunakan untuk mengakses proxy API 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 dapat berupa pengujian atau produksi.

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 dibatasi untuk satu organisasi. Beberapa pemegang akun mungkin menentukan atau menjadi anggota dari beberapa organisasi yang mendukung berbagai komunitas developer aplikasi.

Environment Konteks eksekusi runtime untuk proxy API dalam organisasi. Lihat bagian di bawah ini untuk mengetahui informasi selengkapnya tentang lingkungan.

Pengguna

Dalam organisasi, di mana 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, proxy API dan pembuat produk API, pengguna yang memantau analisis dan statistik lainnya, serta lainnya.

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 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 Edge untuk mendukung berbagai komunitas developer. Namun, secara internal, orang-orang yang sama membangun semua proxy API dan produk API, sehingga menjadi anggota dari semua organisasi Anda.

Anda tidak perlu 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 penting lainnya pada permintaan, respons, dan dengan pemanggilan layanan.

Edge mengumpulkan data untuk analisis tentang proxy API.

Produk API

Pengguna di organisasi membuat satu atau beberapa produk API, dengan produk API berupa 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

Sebuah organisasi berisi satu atau beberapa developer yang membangun aplikasi yang menggunakan API tersebut (disusun menjadi 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, mereka dapat menjadi partner, atau dapat berupa developer eksternal yang membayar untuk mengakses API Anda.

Developer harus terdaftar di organisasi Anda sebelum dapat mendaftarkan aplikasi dan menerima kunci API untuk mengakses API Anda. Sebagai penyedia API, Anda bebas menentukan cara menambahkan, mengupdate, 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 menggunakan Edge Management API.

Developer tidak perlu memiliki akun di Edge, dan sebagian besar developer tidak perlu mengetahui apa pun tentang Edge. Jika developer memiliki akun di Edge, biasanya sebagai pengguna di organisasi yang berbeda, atau menggunakan Layanan Edge API.

Aplikasi

Developer membuat satu atau beberapa aplikasi klien yang menggunakan API Anda.

Developer harus mendaftarkan aplikasi mereka di organisasi Anda. Aplikasi di Edge adalah representasi dari aplikasi sebenarnya milik developer yang menyediakan kunci API kepada developer untuk diteruskan bersama setiap permintaan ke API Anda.

Karena semua aplikasi terdaftar di organisasi, Anda dapat menggunakan Edge untuk memantau dan mengumpulkan informasi analisis di aplikasi serta penggunaan API Anda.

Kunci API/token OAuth

Bergantung pada mekanisme otorisasi yang Anda tentukan untuk API, aplikasi akan meneruskan kunci API bersama setiap permintaan ke API Anda. Jika kunci tersebut valid, permintaan akan diizinkan. Edge mendukung berbagai jenis autentikasi, seperti kunci API sederhana, OAuth bercabang dua, OAuth bercabang tiga, dan lainnya.

Sebagai penyedia API, Anda harus menentukan cara bagi developer untuk mendaftarkan aplikasi mereka. Dengan mendaftarkan aplikasinya, Anda akan mengembalikan kunci yang diperlukan untuk mengakses API Anda kepada developer.

Pada saat pendaftaran aplikasi, developer dapat memilih untuk mengakses satu produk API atau beberapa produk API. Aplikasi sebenarnya dari developer menggunakan kunci yang sama untuk mengakses semua produk API yang terkait dengan aplikasi tersebut (representasi terdaftar dari aplikasi developer di Edge).

Anda dapat mencabut kunci tersebut 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 menentukan batas waktu pada kunci sehingga developer harus memuat ulang kunci tersebut 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 beberapa lingkungan.

Sebuah 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 disediakan di tingkat organisasi, yang berarti Proxy API yang di-deploy ke lingkungan apa 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.

Berikut adalah entitas utama yang Anda kelola dalam organisasi, termasuk entitas yang didefinisikan secara global dalam organisasi, dan entitas yang ditentukan secara khusus untuk lingkungan: