คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
องค์กรคือคอนเทนเนอร์ระดับบนสุดใน Apigee Edge ซึ่งมีพร็อกซี API ทั้งหมดและทรัพยากรที่เกี่ยวข้อง ส่วนที่เหลือของหัวข้อนี้เจาะลึกเพิ่มเติมเกี่ยวกับองค์กรต่างๆ ต่อไปนี้คือตัวอย่างประเด็นที่ปฏิบัติได้จริง
- โดยค่าเริ่มต้น ชื่อองค์กรจะอยู่ใน URL ที่ใช้เรียกพร็อกซี API ตามที่อธิบายไว้ในเกี่ยวกับโฮสต์เสมือน
ตัวอย่างเช่น
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- ชื่อองค์กรอยู่ใน URL ของ UI การจัดการ Edge ตัวอย่างเช่น URL ต่อไปนี้แสดงพร็อกซี API สำหรับองค์กร
docs
- แม้ว่าคุณจะสร้างองค์กรเพียงแห่งเดียว แต่คุณอาจอยู่ในองค์กรอื่นในฐานะผู้ใช้หรือผู้ดูแลระบบที่มีสิทธิ์บางอย่างได้ ใน UI การจัดการ Edge หากคุณอยู่ในองค์กรมากกว่า 1 แห่ง คุณจะเปลี่ยนไปใช้องค์กรอื่นได้ตามที่อธิบายไว้ในหัวข้อการสลับระหว่างองค์กร
- เมื่อคุณโทรออกด้วย Management API ในฐานะผู้ใช้ในบทบาทผู้ดูแลระบบองค์กร องค์กรจะเป็นส่วนที่จำเป็นของเส้นทางในการเรียกส่วนใหญ่ ตัวอย่างเช่น คำขอ cURL ของ API การจัดการต่อไปนี้แสดงผลรายการพร็อกซี API ทั้งหมดในองค์กร:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
วิดีโอ: ดูวิดีโอสั้นๆ เพื่อดูว่าองค์กรต่างๆ รองรับสถาปัตยกรรมแบบหลายกลุ่มผู้ใช้สำหรับการจัดการ API อย่างไร
องค์ประกอบขององค์กร
เมื่อคุณสร้างบัญชี Edge แล้ว Edge จะสร้างองค์กรให้คุณโดยอัตโนมัติ เมื่อสร้างแล้ว คุณจะเพิ่มผู้ใช้ลงในองค์กร สร้างพร็อกซี API และผลิตภัณฑ์ API รวมถึงลงทะเบียนนักพัฒนาแอปและแอปได้
รูปภาพต่อไปนี้แสดงองค์ประกอบหลักของโมเดลองค์กร Edge โมเดลนี้กำหนดว่า API, ผลิตภัณฑ์ API, แอป และนักพัฒนาแอปของคุณมีความเกี่ยวข้องกันภายใน Edge อย่างไร
โมเดลนี้ไม่ได้แสดงฟีเจอร์ทั้งหมดของ Apigee Edge หากคุณใช้การสร้างรายได้ โมเดลจะมีคอมโพเนนต์เพิ่มเติม ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการสร้างรายได้ ดูจัดการบริษัทและนักพัฒนาซอฟต์แวร์สำหรับข้อมูลเกี่ยวกับการจัดการบริษัทและนักพัฒนาซอฟต์แวร์ด้วยการสร้างรายได้
ชื่อองค์กร
ชื่อขององค์กรคือ
- องค์กรการประเมิน:
username-eval - องค์กรที่ชำระเงิน: กำหนดโดยผู้ใช้ในเวลาการจัดสรรเริ่มต้น
เมื่อสร้างแล้ว คุณจะเปลี่ยนชื่อองค์กรไม่ได้
ชื่อองค์กรจะกลายเป็นส่วนหนึ่งของ URL ไปยังพร็อกซี API และเป็นส่วนหนึ่งของ URL เมื่อส่งคำขอไปยัง Edge Management API ตัวอย่างเช่น URL ทั่วไปที่ใช้เข้าถึงพร็อกซี API จะมีรูปแบบดังนี้
http://org-name-env.apigee.net/v1/weather/forecastrss
ที่ไหน
- org-name คือชื่อองค์กรของคุณ
- env คือสภาพแวดล้อมการติดตั้งใช้งานของพร็อกซี API ซึ่งอาจเป็นเวอร์ชันทดสอบหรือเวอร์ชันที่ใช้งานจริง
เช่น
http://myorg-test.apigee.net/v1/weather/forecastrss
องค์ประกอบขององค์กร
ตารางต่อไปนี้จะอธิบายถึงองค์ประกอบของรูปแบบองค์กรโดยละเอียดยิ่งขึ้น
| ส่วนประกอบ | คำอธิบาย |
|---|---|
|
องค์กร |
บัญชี Apigee ทุกบัญชีจะแมปกับองค์กรอย่างน้อย 1 แห่งใน Apigee Edge องค์กรดังกล่าวมีการนำเสนอคอมโพเนนต์ทั้งหมด ซึ่งรวมถึงพร็อกซี API, ผลิตภัณฑ์ API, แพ็กเกจ API, แอป และนักพัฒนาซอฟต์แวร์ เจ้าของบัญชีไม่ได้จำกัดอยู่เพียงองค์กรเดียว เจ้าของบัญชีบางรายอาจ กำหนดหรือเป็นสมาชิกของหลายองค์กรที่สนับสนุนชุมชนนักพัฒนาแอป ที่แตกต่างกัน |
| สภาพแวดล้อม | บริบทของการดำเนินการรันไทม์สำหรับพร็อกซี API ในองค์กร ดูข้อมูลเพิ่มเติมเกี่ยวกับสภาพแวดล้อมได้ที่ส่วนด้านล่าง |
|
ผู้ใช้ |
ภายในองค์กร ซึ่งผู้ที่สร้างบัญชีจะเป็นผู้ดูแลระบบโดยอัตโนมัติ คุณจะสร้างผู้ใช้เพิ่มเติมได้ ผู้ใช้ประกอบขึ้นเป็นทีม API ขององค์กร ซึ่งประกอบด้วยบุคคลต่างๆ เช่น ผู้ดูแลระบบ พร็อกซี API และผู้สร้างผลิตภัณฑ์ API ผู้ใช้ตรวจสอบข้อมูลวิเคราะห์และสถิติอื่นๆ และอื่นๆ ผู้ใช้แต่ละคนสามารถมีบทบาทและสิทธิ์การเข้าถึงที่แตกต่างกัน เช่น กำหนดผู้ใช้บางรายเป็นผู้ดูแลระบบองค์กรและผู้ดูแลระบบการดำเนินการที่มีสิทธิ์ในการแก้ไของค์กรและคอมโพเนนต์ กำหนดผู้ใช้รายอื่นๆ ที่มีสิทธิ์สร้างพร็อกซี API และผลิตภัณฑ์ API แต่ไม่มีสิทธิ์แก้ไขผู้ใช้รายอื่น ผู้ใช้สามารถเป็นสมาชิกหลายองค์กร เช่น บริษัทอาจกำหนดองค์กรหลายแห่งใน Apigee Edge เพื่อรองรับชุมชนนักพัฒนาซอฟต์แวร์ต่างๆ แต่ภายในองค์กร บุคคลเดียวกันจะสร้างพร็อกซี API และผลิตภัณฑ์ API ทั้งหมด และด้วยเหตุนี้ จึงเป็นสมาชิกของทุกองค์กร คุณไม่จำเป็นต้องสร้างบัญชี Apigee หรือก็คือสร้างองค์กร Apigee เป็นผู้ใช้ ผู้ดูแลระบบสามารถเพิ่มคุณลงในองค์กรที่มีอยู่ได้ ผู้ใช้ทุกคนจะลงชื่อเข้าสู่ระบบ Apigee Edge ได้ที่นี่ https://enterprise.apigee.com |
|
พร็อกซี API |
ผู้ใช้ในองค์กรสร้างพร็อกซี API อย่างน้อย 1 รายการ พร็อกซี API กำหนดการแมปปลายทาง HTTP ที่พร้อมใช้งานแบบสาธารณะกับบริการแบ็กเอนด์ นอกจากนี้ คุณยังกำหนดค่าพร็อกซี API ให้รวมการรักษาความปลอดภัย (เช่น OAuth) ดำเนินการเปลี่ยนรูปแบบข้อความ (เช่น XML เป็น JSON) จำกัดการรับส่งข้อมูลไปยังบริการแบ็กเอนด์ และดำเนินการอื่นๆ ที่มีคุณค่าในคำขอ การตอบกลับ และการเรียกใช้บริการได้ Edge รวบรวมข้อมูลสำหรับการวิเคราะห์เกี่ยวกับพร็อกซี API |
|
ผลิตภัณฑ์ API |
ผู้ใช้ในองค์กรสร้างผลิตภัณฑ์ API อย่างน้อย 1 รายการ โดยที่ผลิตภัณฑ์ API คือชุดพร็อกซี API ที่รวมกับแผนบริการ แผนบริการดังกล่าวจะกำหนดขีดจำกัดการเข้าถึงพร็อกซี API, มอบการรักษาความปลอดภัย, อนุญาตการตรวจสอบและการวิเคราะห์ และมีฟีเจอร์เพิ่มเติม Edge รวบรวมข้อมูลสำหรับข้อมูลวิเคราะห์เกี่ยวกับผลิตภัณฑ์ API |
|
นักพัฒนาแอป |
องค์กรมีนักพัฒนาซอฟต์แวร์อย่างน้อย 1 รายที่สร้างแอปที่ใช้ API (ประกอบเป็นผลิตภัณฑ์ API) ที่กำหนดโดยองค์กรของคุณ นักพัฒนาซอฟต์แวร์ใช้ API แต่สร้าง API หรือดำเนินการอื่นๆ ในองค์กรไม่ได้ นักพัฒนาซอฟต์แวร์อาจเป็นนักพัฒนาซอฟต์แวร์ภายในองค์กร อาจเป็นพาร์ทเนอร์ หรืออาจเป็นนักพัฒนาซอฟต์แวร์ภายนอกที่ชําระเงินเพื่อเข้าถึง API ของคุณ นักพัฒนาซอฟต์แวร์ต้องลงทะเบียนในองค์กรของคุณก่อนจึงจะลงทะเบียนแอปและรับคีย์ API เพื่อเข้าถึง API ได้ ในฐานะผู้ให้บริการ API คุณจะเป็นผู้กำหนดวิธีเพิ่ม อัปเดต หรือนำนักพัฒนาซอฟต์แวร์ในองค์กรออก คุณสามารถเพิ่มรหัสดังกล่าวด้วยตนเองผ่าน UI การจัดการ Edge, สร้างพอร์ทัลนักพัฒนาซอฟต์แวร์เพื่อลงทะเบียนผ่านเว็บไซต์ หรือกำหนดกลไกการลงทะเบียนของคุณเองโดยใช้ Edge Management API นักพัฒนาแอปไม่จำเป็นต้องมีบัญชีใน Edge และนักพัฒนาซอฟต์แวร์ส่วนใหญ่ก็ไม่จําเป็นต้องทราบข้อมูลใดๆ เกี่ยวกับ Edge หากนักพัฒนาแอปมีบัญชีใน Edge ตามปกติจะเป็นของผู้ใช้ในองค์กรอื่นหรือใช้บริการ Edge API |
|
แอป |
นักพัฒนาแอปจะสร้างแอปไคลเอ็นต์อย่างน้อย 1 แอปที่ใช้ API ของคุณ นักพัฒนาแอปต้องลงทะเบียนแอปกับองค์กรของคุณ แอปใน Edge เป็นตัวแทนของแอปจริงของนักพัฒนาแอปซึ่งให้คีย์ API แก่นักพัฒนาแอปเพื่อส่งผ่านคำขอไปยัง API ของคุณทุกรายการ เนื่องจากแอปทั้งหมดได้รับการลงทะเบียนในองค์กรของคุณ คุณจึงใช้ Edge เพื่อตรวจสอบและรวบรวมข้อมูลการวิเคราะห์ในแอปและการใช้ API ได้ |
|
คีย์ API/โทเค็น OAuth |
แอปจะส่งคีย์ API พร้อมกับคำขอทุกรายการไปยัง API ของคุณ ทั้งนี้ขึ้นอยู่กับกลไกการให้สิทธิ์ที่คุณกำหนดสำหรับ API หากคีย์ดังกล่าวถูกต้อง ระบบจะอนุญาตคำขอ Edge รองรับการตรวจสอบสิทธิ์ประเภทต่างๆ เช่น คีย์ API แบบง่าย, OAuth แบบ 2 ทาง, OAuth แบบ 3 ทาง และอื่นๆ ในฐานะผู้ให้บริการ API คุณต้องกำหนดวิธีที่นักพัฒนาแอปจะลงทะเบียนแอปของตน การลงทะเบียนแอปจะทำให้คุณกลับไปยังนักพัฒนาซอฟต์แวร์ได้ โดยคีย์ที่จำเป็นสำหรับการเข้าถึง API ของคุณ ณ เวลาที่ลงทะเบียนแอป นักพัฒนาซอฟต์แวร์สามารถเลือกที่จะเข้าถึงผลิตภัณฑ์ API เดียวหรือผลิตภัณฑ์ API หลายรายการ แอปจริงของนักพัฒนาแอปใช้คีย์เดียวกันเพื่อเข้าถึงผลิตภัณฑ์ API ทั้งหมดที่เชื่อมโยงกับแอป (การเป็นตัวแทนที่ลงทะเบียนของแอปของนักพัฒนาแอปใน Edge) คุณเพิกถอนคีย์ได้ทุกเมื่อเพื่อไม่ให้แอปของนักพัฒนาแอปเข้าถึง API ของคุณอีกต่อไป (แม้ว่าตัวแทนแอปของนักพัฒนาแอปที่ลงทะเบียนจะยังอยู่ในองค์กรของคุณก็ตาม) หรือคุณจะกำหนดขีดจำกัดเวลาของคีย์เพื่อให้นักพัฒนาซอฟต์แวร์ต้องรีเฟรชคีย์หลังจากเวลาที่ระบุก็ได้ |
เกี่ยวกับสภาพแวดล้อม
สภาพแวดล้อมคือบริบทของการดำเนินการรันไทม์สำหรับพร็อกซี API ในองค์กร คุณต้องทำให้พร็อกซี API ใช้งานได้กับสภาพแวดล้อมก่อนจึงจะเข้าถึงได้ คุณจะทำให้พร็อกซี API ใช้งานได้ในสภาพแวดล้อมเดียวหรือหลายสภาพแวดล้อมก็ได้
องค์กรหนึ่งอาจมีหลายสภาพแวดล้อมได้ ตัวอย่างเช่น คุณอาจกำหนดสภาพแวดล้อม dev, test และ prod ในองค์กร
องค์กรกำหนดขอบเขตสำหรับความสามารถบางอย่างของ Apigee เช่น ข้อมูลคีย์-ค่าแมป (KVM) อาจใช้งานได้ในระดับองค์กร ซึ่งหมายความว่าพร็อกซี API ที่ใช้งานได้กับทุกสภาพแวดล้อมจะได้รับข้อมูลเดียวกันจาก KVM ความสามารถบางอย่าง เช่น การแคช อาจกำหนดขอบเขตได้สำหรับองค์กรหรือสภาพแวดล้อมเฉพาะภายในองค์กร ข้อมูลวิเคราะห์ของ Apigee ถูกแบ่งพาร์ติชันตามองค์กรและสภาพแวดล้อม
ด้านล่างนี้เป็นเอนทิตีหลักที่คุณจัดการภายในองค์กร รวมถึงเอนทิตีที่กำหนดทั่วโลกในองค์กร และเอนทิตีที่กำหนดสำหรับสภาพแวดล้อมโดยเฉพาะ
