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

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

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

  • โดยค่าเริ่มต้น ชื่อองค์กรจะอยู่ใน 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 องค์กร คุณสามารถเปลี่ยนไปใช้องค์กรอื่นได้ตามที่อธิบายไว้ในหัวข้อการเปลี่ยนไปใช้องค์กรอื่น

  • เมื่อคุณเรียกใช้ Management API ในฐานะผู้ใช้ที่มีบทบาทเป็นผู้ดูแลระบบองค์กร องค์กรจะเป็นส่วนหนึ่งของเส้นทางที่จำเป็นในการเรียกใช้ส่วนใหญ่ ตัวอย่างเช่น คำขอ cURL ของ Management API ต่อไปนี้ จะแสดงรายการพร็อกซี API ทั้งหมดในองค์กร
    curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address

วิดีโอ: ดูวิดีโอสั้นๆ เพื่อเรียนรู้ว่าองค์กรสนับสนุนสถาปัตยกรรมแบบหลายผู้เช่าสำหรับการจัดการ API ได้อย่างไร

คอมโพเนนต์ขององค์กร

เมื่อคุณสร้างบัญชี 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

โดยที่

  • org-name คือชื่อองค์กร
  • env คือสภาพแวดล้อมการทำให้ใช้งานได้ของพร็อกซี API ซึ่งอาจเป็น test หรือ prod

เช่น

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 โดยปกติแล้วจะเป็นผู้ใช้ในองค์กรอื่น หรือใช้บริการ API ของ Edge

แอป

นักพัฒนาแอปสร้างแอปไคลเอ็นต์อย่างน้อย 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 เช่น คุณสามารถทำให้ข้อมูล Key-Value-Map (KVM) พร้อมใช้งานในระดับองค์กร ซึ่งหมายความว่าพร็อกซี API ที่ทำให้ใช้งานได้กับสภาพแวดล้อมใดก็ตาม จะได้รับข้อมูลเดียวกันจาก KVM ความสามารถบางอย่าง เช่น การแคช สามารถกำหนดขอบเขต เป็นองค์กรหรือสภาพแวดล้อมที่เฉพาะเจาะจงภายในองค์กรได้ ระบบจะแบ่งพาร์ติชันข้อมูลวิเคราะห์ของ Apigee ตามการผสมผสานระหว่างองค์กรและสภาพแวดล้อม

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