การทำความเข้าใจองค์กร

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

องค์กรคือคอนเทนเนอร์ระดับบนสุดใน Apigee Edge ซึ่งมีพร็อกซี API และทรัพยากรที่เกี่ยวข้องทั้งหมด แม้ว่าส่วนที่เหลือของหัวข้อนี้จะเจาะลึกเกี่ยวกับองค์กร แต่ต่อไปนี้เป็นประเด็นที่เป็นประโยชน์ 2-3 ข้อ

  • โดยค่าเริ่มต้น ชื่อองค์กรจะอยู่ใน URL ที่ใช้ในการเรียกพร็อกซี API ตามที่อธิบายไว้ในเกี่ยวกับโฮสต์เสมือน เช่น 
    http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
  • โดยชื่อองค์กรของคุณจะอยู่ใน URL ของ UI การจัดการ Edge ตัวอย่างเช่น URL ต่อไปนี้จะแสดงพร็อกซี API สําหรับองค์กร docs

    ใน URL apigee.com/organizations/docs/proxies มีการทำเครื่องหมายวงกลมไว้ที่ /docs/

  • แม้ว่าคุณจะสร้างองค์กรเพียงองค์กรเดียว แต่ก็สามารถเป็นสมาชิกขององค์กรอื่นๆ ในฐานะผู้ใช้หรือผู้ดูแลระบบที่มีสิทธิ์เฉพาะได้ ใน UI การจัดการ Edge หากคุณอยู่ในองค์กรมากกว่า 1 แห่ง คุณอาจเปลี่ยนไปใช้องค์กรอื่นตามที่อธิบายไว้ในการสลับระหว่างองค์กร

  • เมื่อคุณเรียกใช้โดยใช้ API การจัดการในฐานะผู้ใช้ในบทบาทผู้ดูแลระบบองค์กร องค์กรเป็นส่วนที่กำหนดของเส้นทางในการเรียกใช้ส่วนใหญ่ ตัวอย่างเช่น คำขอ cURL ของ Management 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

แผนภาพแสดงวิธีที่สภาพแวดล้อม ผู้ใช้ ผลิตภัณฑ์ API และผู้พัฒนาแอปเกี่ยวข้องกับแอป คีย์ API/โทเค็น OAuth และพร็อกซี API

โมเดลนี้ไม่ได้แสดงฟีเจอร์ทั้งหมดของ Apigee Edge หากคุณใช้การสร้างรายได้ รูปแบบจะมีคอมโพเนนต์เพิ่มเติม ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการสร้างรายได้ ดูข้อมูลเกี่ยวกับการจัดการบริษัทและนักพัฒนาแอปที่มีสิทธิ์สร้างรายได้ได้ที่หัวข้อจัดการบริษัทและนักพัฒนาแอป

ชื่อองค์กร

ชื่อองค์กรคือ

  • องค์กรการประเมิน: username-eval
  • องค์กรแบบชำระเงิน: ผู้ใช้กำหนดไว้ ณ เวลาที่จัดสรรครั้งแรก

เมื่อสร้างแล้ว คุณจะเปลี่ยนชื่อองค์กรไม่ได้

ชื่อองค์กรจะกลายเป็นส่วนหนึ่งของ URL ไปยังพร็อกซี API และเป็นส่วนหนึ่งของ URL เมื่อส่งคำขอไปยัง Edge Management API ตัวอย่างเช่น URL ทั่วไปที่ใช้เข้าถึงพร็อกซี API จะมีรูปแบบดังนี้

http://org-name-env.apigee.net/v1/weather/forecastrss

where:

  • 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 ทั้งหมดที่เชื่อมโยงกับแอป (การแสดงแอปของนักพัฒนาแอปที่ลงทะเบียนใน Edge)

คุณสามารถเพิกถอนคีย์ได้ทุกเมื่อเพื่อให้แอปของนักพัฒนาแอปไม่มีสิทธิ์เข้าถึง API ของคุณอีกต่อไป (แม้ว่าตัวแทนที่จดทะเบียนของแอปนักพัฒนาแอปจะยังคงอยู่ในองค์กรของคุณก็ตาม) หรือจะกำหนดขีดจำกัดเวลาในคีย์เพื่อให้นักพัฒนาแอปต้องรีเฟรชคีย์หลังจากผ่านไปตามเวลาที่เจาะจงก็ได้

เกี่ยวกับสภาพแวดล้อม

สภาพแวดล้อมคือบริบทการเรียกใช้รันไทม์สําหรับพร็อกซี API ในองค์กร คุณต้องติดตั้งใช้งานพร็อกซี API ในสภาพแวดล้อมก่อนจึงจะเข้าถึงได้ คุณสามารถติดตั้งใช้งานพร็อกซี API ในสภาพแวดล้อมเดียวหรือหลายสภาพแวดล้อมก็ได้

องค์กรหนึ่งอาจมีหลายสภาพแวดล้อมได้ ตัวอย่างเช่น คุณอาจกำหนดสภาพแวดล้อม dev, test และ prod ในองค์กร

องค์กรจะกำหนดขอบเขตสำหรับความสามารถบางอย่างของ Apigee เช่น ข้อมูลการแมปคีย์-ค่า (KVM) สามารถใช้ได้ในระดับองค์กร ซึ่งหมายความว่าพร็อกซี API ที่ติดตั้งใช้งานในสภาพแวดล้อมใดก็ตามจะได้รับข้อมูลเดียวกันจาก KVM ความสามารถบางอย่าง เช่น การแคช สามารถกําหนดขอบเขตให้กับองค์กรหรือสภาพแวดล้อมที่เฉพาะเจาะจงภายในองค์กรได้ ข้อมูลวิเคราะห์ของ Apigee จะแบ่งพาร์ติชันตามองค์กรและสภาพแวดล้อม

รายการต่อไปนี้คือเอนทิตีหลักที่คุณจัดการภายในองค์กร ซึ่งรวมถึงเอนทิตีที่กําหนดไว้ทั่วโลกในองค์กร และเอนทิตีที่กําหนดไว้สําหรับสภาพแวดล้อมหนึ่งๆ โดยเฉพาะ