คำขอ API ภายนอก

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

คำนิยาม

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

1. หากต้องการกำหนดเทมเพลตคำขอใหม่ ให้ไปที่แท็บ "ตรรกะทางธุรกิจ" บนแถบด้านข้าง (1) สลับไปที่แท็บ "คำขอ API ภายนอก" (2) แล้วคลิก "คำขอ API ใหม่" (3)

2. ตั้งชื่อคำขอใหม่และคำอธิบายเพิ่มเติม

3. เลือกวิธี HTTP ของคำขอและ URL

4. กำหนดพารามิเตอร์ URL พารามิเตอร์การค้นหา (สำหรับคำขอ GET เท่านั้น) ส่วนหัว และเนื้อหาของคำขอโดยป้อนชื่อพารามิเตอร์ (1) ประเภท (2) และคลิก "เพิ่มพารามิเตอร์" (3)

ค่าจริงของพารามิเตอร์เหล่านี้จะถูกกำหนดไว้ ณ เวลาที่ดำเนินการตามกระบวนการทางธุรกิจ ซึ่งคำขอถูกทริกเกอร์

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

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

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

ในกรณีที่คำขอของคุณมีวัตถุ (เช่น รถยนต์ -> สี ขนาด ฯลฯ) คุณจะต้องสร้างแบบจำลองเสมือนจริงเพื่อประมวลผลวัตถุเหล่านี้ในภายหลังในกระบวนการทางธุรกิจของคุณ โดยเลือก "Model" ในตัวเลือกประเภทพารามิเตอร์ และแนะนำองค์ประกอบย่อยที่คุณต้องการ คุณสามารถซ้อนวัตถุได้หลายครั้งตามที่คุณต้องการ (เช่น วัตถุภายในวัตถุ) และสร้างอาร์เรย์แบบจำลองเสมือน ในกรณีที่คุณใช้การป้อนข้อความอัตโนมัติ กระบวนการนี้จะเสร็จสมบูรณ์โดยอัตโนมัติ

5. เปลี่ยนการตั้งค่าของคำขอ เช่น การยืนยัน SSL การหมดเวลา และการจัดการข้อผิดพลาดในแท็บ "การตั้งค่า"

6. ทดสอบคำขอโดยคลิก "ทดสอบคำขอ" และป้อนพารามิเตอร์ที่จำเป็นทั้งหมด ตรวจสอบการตอบกลับจากเซิร์ฟเวอร์และกรอกส่วนหัวและเนื้อหาการตอบกลับโดยอัตโนมัติ หรือดำเนินการด้วยตนเอง

7. บันทึกเทมเพลตคำขอโดยคลิก "บันทึกคำขอ"

ใช้

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

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

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

สำหรับแบบจำลองเสมือนทั้งหมดที่คุณกำหนดไว้ บล็อกใหม่ 2 บล็อกจะถูกเพิ่มใน Business Process Editor ของคุณเพื่อสร้างและขยาย

การตรวจสอบ

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