โครงการ API (ทางเลือก)

แสดงการทำงานของแอปพลิเคชันตามที่ตกลงไว้เมื่อคุณต้องการ

ตรวจสอบขอบเขตของ API สำหรับโปรเจ็กต์ที่เกี่ยวข้อง และแยกแยะเส้นทางที่วางแผนไว้จากจุดปลายที่สร้างขึ้นแล้ว

พิจารณา API เป็นตัวเลือกของโครงการที่กำหนด

ตรวจสอบตัวเลือก

ตรวจสอบว่า API พร้อมใช้งานและข้อเสนอโครงการที่เกี่ยวข้องหรือไม่

กำหนดขอบเขตเส้นทาง

ระบุให้ชัดเจนถึงการทำงานทางธุรกิจที่ API ควรเปิดเผย

ตรวจสอบแคตตาล็อกเส้นทาง

ดูวิธีการ, เส้นทาง, และสถานะปัจจุบันหรือตามกำหนดการของแต่ละเส้นทาง

เพิ่ม API เมื่อโปรเจกต์ของคุณต้องการ

API ของโปรเจ็กต์เป็นส่วนเสริมของข้อเสนอ ตรวจสอบขอบเขตและเงื่อนไขก่อนเปิดใช้งาน แทนที่จะคิดว่าทุกแอปพลิเคชันมี API

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

แยกแยะเส้นทางที่ต้องการออกจากจุดเชื่อมต่อที่ใช้งานได้จริง

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

ตรวจสอบแค็ตตาล็อกเส้นทาง. แคตตาล็อกแสดงวิธีการ เส้นทาง คำอธิบาย และสถานะของแต่ละเส้นทาง ช่วยแยกแยะขอบเขตที่เสนอออกจากจุดปลายที่ลงทะเบียนว่าเป็นแบบใช้งานจริง นี่คือแหล่งข้อมูลอ้างอิงที่มีประโยชน์เมื่อดำเนินการตามขั้นตอนการเตรียม API

เลือทิศทางการผสานรวมที่ถูกต้อง. การใช้ API ของผู้ให้บริการรายอื่นและการเผยแพร่แอปพลิเคชันของคุณเองเป็นความต้องการที่แตกต่างกัน การเชื่อมต่อภายนอกครอบคลุมถึงกรณีแรก ในขณะที่ API ของโปรเจ็กต์ครอบคลุมการเผยแพร่ตามข้อตกลง เลือกเส้นทางที่ตรงกับรูปแบบการแลกเปลี่ยนทางธุรกิจที่คุณต้องการ

แยกแยะ API ที่เปิดให้ใช้งาน กับการเชื่อมต่อภายนอก

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

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

ประเมินตัวเลือก API โดยอ้างอิงจากความต้องการที่เฉพาะเจาะจง

ระบุว่าใครจะเป็นผู้ใช้ข้อมูลของโครงการ และการผสานรวมนั้นต้องใช้การดำเนินการใดบ้าง ซึ่งจะช่วยแยกแยะขอบเขต API ที่เป็นทางเลือกออกจากส่วนเชื่อมต่อกับบริการภายนอกที่มีอยู่

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

จากขอบเขตที่ไม่บังคับเป็นขอบเขตที่ได้รับการยืนยัน

ตรวจสอบความพร้อมใช้งานและเงื่อนไข. ตรวจสอบตัวเลือก API ในข้อเสนอโครงการจริง ตัดสินใจว่าแอปพลิเคชันจำเป็นต้องมีการเปิดเผยข้อมูลนี้ก่อนเปิดใช้งานหรือไม่

อธิบายขั้นตอนการทำงาน. ตรวจสอบแผนการดำเนินงานที่เสนอ และตอบคำถามเกี่ยวกับพฤติกรรมที่คาดว่าจะเกิดขึ้น ปฏิบัติตามขั้นตอนการเตรียมและการก่อสร้าง

ดูว่ามีอะไรบ้าง. ตรวจสอบแคตตาล็อกเส้นทางและเอกสารอ้างอิงที่เผยแพร่สำหรับโครงการที่เปิดใช้งาน เส้นทางที่วางแผนไว้ไม่ใช่จุดสิ้นสุดที่ใช้งานได้

กำหนดขอบเขตการผสานรวมก่อนเพิ่ม API

อธิบายถึงการทำงานที่ระบบอื่นต้องการ และตรวจสอบเงื่อนไขของตัวเลือก API ควรให้บริการตามข้อตกลงทางธุรกิจ

คำถามเกี่ยวกับ Optional project API

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

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

มุมมอง API ของโครงการแสดงพื้นที่ที่จะเปิดเผย คำถาม โครงสร้างพื้นฐาน และสถานะการก่อสร้าง แก้ไขข้อกำหนดเบื้องต้นที่ระบุ และตรวจสอบแคตตาล็อกเส้นทางที่ได้

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

พวกเขาอธิบายถึงบริการอื่น ๆ ที่แอปพลิเคชันของคุณใช้ การเชื่อมต่อในลักษณะนั้นแตกต่างจากการเผยแพร่การทำงานของแอปพลิเคชันของคุณผ่าน API ของโปรเจ็กต์