คุณกำลังดูเอกสารประกอบ 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 องค์กร คุณสามารถเปลี่ยนไปใช้องค์กรอื่นตามที่อธิบายไว้ในการสลับระหว่างองค์กร
- เมื่อคุณเรียกใช้ด้วย API การจัดการในฐานะผู้ใช้ในผู้ดูแลระบบองค์กร
องค์กรเป็นส่วนที่จำเป็นของเส้นทางในการเรียกส่วนใหญ่ ตัวอย่างเช่น URL ต่อไปนี้
คำขอ 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 ซึ่งเป็นได้ทั้งการทดสอบหรือ Prod
เช่น
http://myorg-test.apigee.net/v1/weather/forecastrss
องค์ประกอบขององค์กร
ตารางต่อไปนี้อธิบายคอมโพเนนต์ของโมเดลองค์กรโดยละเอียดยิ่งขึ้น
ส่วนประกอบ | คำอธิบาย |
---|---|
องค์กร |
บัญชี Apigee ทุกบัญชีจะแมปกับองค์กรอย่างน้อย 1 องค์กรใน Apigee Edge องค์กรมีการนำเสนอคอมโพเนนต์ทั้งหมดรวมถึงพร็อกซี 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 API นักพัฒนาซอฟต์แวร์ไม่จำเป็นต้องมีบัญชีใน Edge และนักพัฒนาซอฟต์แวร์ส่วนใหญ่จะไม่ ต้องการรู้อะไรเกี่ยวกับ Edge หากนักพัฒนาซอฟต์แวร์มีบัญชี Edge ซึ่งมักจะเป็นผู้ใช้ในองค์กรอื่น หรือเพื่อใช้บริการ Edge API |
แอป |
นักพัฒนาแอปจะสร้างแอปไคลเอ็นต์อย่างน้อย 1 แอปที่ใช้ API ของคุณ นักพัฒนาแอปต้องลงทะเบียนแอปกับองค์กรของคุณ แอปใน Edge คือ การนำเสนอแอปจริงของนักพัฒนาซอฟต์แวร์ ซึ่งให้คีย์ API แก่นักพัฒนาแอป ส่งไปพร้อมกับคำขอทุกรายการไปยัง API ของคุณ เนื่องจากแอปทั้งหมดมีการลงทะเบียนในองค์กรของคุณ คุณจึงใช้ Edge เพื่อตรวจสอบและ รวบรวมข้อมูลการวิเคราะห์ในแอปและการใช้งาน API |
คีย์ API/โทเค็น OAuth |
แอปจะส่งผ่าน คีย์ API พร้อมกับคำขอทุกรายการที่ส่งไปยัง API หากคีย์นั้นถูกต้อง คำขอจะ อนุญาต Edge รองรับการตรวจสอบสิทธิ์ประเภทต่างๆ เช่น คีย์ API แบบง่าย OAuth สองทิศทาง, OAuth แบบสามทาง และอื่นๆ ในฐานะผู้ให้บริการ API คุณต้องกำหนดวิธีให้นักพัฒนาแอปลงทะเบียนแอป ใช่เลย โดยการลงทะเบียนแอปโดยที่คุณส่งคืน ให้นักพัฒนาซอฟต์แวร์ทราบ คีย์ที่จำเป็นในการเข้าถึง API ในช่วงเวลาลงทะเบียนแอป นักพัฒนาแอปเลือกที่จะเข้าถึง API รายการเดียวได้ ผลิตภัณฑ์หรือ API หลายรายการ แอปจริงของนักพัฒนาซอฟต์แวร์ใช้คีย์เดียวกันเพื่อเข้าถึง ผลิตภัณฑ์ API ทั้งหมดที่เชื่อมโยงกับแอป (การเป็นตัวแทนที่ลงทะเบียนของ แอปของนักพัฒนาแอปใน Edge) คุณสามารถเพิกถอนคีย์ได้ทุกเมื่อเพื่อไม่ให้แอปของนักพัฒนาแอปเข้าถึงได้อีก ลงใน API (แม้ว่าตัวแทนที่ลงทะเบียนของแอปของนักพัฒนาซอฟต์แวร์จะยังคง อยู่ในองค์กรของคุณ) หรือคุณสามารถกำหนดขีดจำกัดเวลาของคีย์เพื่อให้ นักพัฒนาซอฟต์แวร์ต้องรีเฟรชคีย์หลังจากเวลาที่ระบุ |
เกี่ยวกับสภาพแวดล้อม
สภาพแวดล้อมเป็นบริบทการดำเนินการรันไทม์สำหรับพร็อกซี API ในองค์กร คุณต้องทำให้พร็อกซี API ใช้งานได้กับสภาพแวดล้อมก่อนจึงจะเข้าถึงได้ คุณสามารถทำให้ API ใช้งานได้ พร็อกซีให้กับสภาพแวดล้อมเดียวหรือหลายสภาพแวดล้อมได้
องค์กรหนึ่งอาจมีหลายสภาพแวดล้อมได้ เช่น คุณอาจกำหนด dev
test
และ prod
ในองค์กร
องค์กรมีขอบเขตความสามารถบางอย่างของ Apigee เช่น คีย์-ค่า-แมป (KVM) ข้อมูลพร้อมใช้งานในระดับองค์กร ซึ่งหมายความว่าพร็อกซี API ที่ทำให้ใช้งานได้กับ ก็จะได้รับข้อมูลเดียวกันจาก KVM ความสามารถบางอย่าง เช่น การแคช อาจกำหนดขอบเขตได้ ต่อองค์กร หรือสภาพแวดล้อมที่เฉพาะเจาะจงภายในองค์กร ข้อมูลวิเคราะห์ Apigee ถูกแบ่งพาร์ติชันตามการรวมองค์กรและสภาพแวดล้อม
ข้อมูลด้านล่างคือองค์กรหลักที่คุณจัดการภายในองค์กร ซึ่งรวมถึงองค์กรที่กำหนดด้วย ทั่วโลกในองค์กร และที่กำหนดไว้สำหรับสภาพแวดล้อมหนึ่งๆ โดยเฉพาะ: