Skip to content

10.02 Recommended API Call Sequence


📌 At a Glance

รายการรายละเอียด
TopicRecommended API Call Sequence
Difficulty⭐⭐ Intermediate
Reading Time8 นาที
TargetDeveloper, System Integrator
Related APIsAuthentication, Master Data APIs, Order Checking APIs, Shipment Tracking APIs

🎯 Learning Objectives

หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ

  • เข้าใจลำดับการเรียกใช้งาน SISAHYGO API ที่แนะนำ
  • ลดจำนวนการเรียก API ที่ไม่จำเป็น
  • ออกแบบระบบให้รองรับ Bulk Order Checking ได้อย่างมีประสิทธิภาพ
  • วางลำดับการทำงานที่เหมาะสมสำหรับ Production Environment

Overview

SISAHYGO API ได้รับการออกแบบให้เรียกใช้งานเป็นลำดับ (Workflow-based Integration) เพื่อให้ Client System สามารถตรวจสอบสิทธิ์ ซิงโครไนซ์ข้อมูลอ้างอิง สร้างรายการตรวจรับสินค้า และติดตามสถานะการจัดส่งได้อย่างมีประสิทธิภาพ

สำหรับ Order Checking API แนะนำให้ Client System รวบรวมรายการตรวจรับสินค้าที่พร้อมส่งเป็น Batch แล้วส่งมายัง API ภายใน Request เดียว (Bulk Submission) แทนการส่งทีละรายการ ซึ่งช่วยลดจำนวน API Calls เพิ่มประสิทธิภาพในการประมวลผล และลดภาระของระบบเครือข่าย


Figure 10-2 Recommended API Call Sequence

Figure 10-2

Figure 10-2 แสดงลำดับการเรียกใช้งาน SISAHYGO API ตั้งแต่การตรวจสอบการเชื่อมต่อ การ Synchronize Master Data การรวบรวมรายการตรวจรับสินค้าแบบ Batch การส่งข้อมูลแบบ Bulk และการติดตามผลการดำเนินงาน


Recommended API Sequence

text
Application Start





GET /ping





GET /profile





Synchronize Master Data

(GET /receivers)

(GET /products)

(GET /units)





Build Batch Orders





Validate Local Data





POST /order-checkings

(Bulk Submission)





Receive Results

(success_count / failed_count)





Retry Failed Orders (if any)





GET /shipments





GET /order-rejections

Processing Flow

StepDescription
1ตรวจสอบการเชื่อมต่อด้วย GET /ping
2ตรวจสอบข้อมูล API Client ด้วย GET /profile
3Synchronize Master Data มาเก็บไว้ใน Local Database
4รวบรวมรายการ Order Checking ที่พร้อมส่ง
5ตรวจสอบข้อมูลภายในระบบ (Local Validation)
6ส่งข้อมูลแบบ Bulk ผ่าน POST /order-checkings
7ตรวจสอบผลลัพธ์ของแต่ละรายการจาก results[]
8Retry เฉพาะรายการที่ล้มเหลว (ถ้ามี)
9ติดตามสถานะผ่าน Shipment Tracking API
10ตรวจสอบรายการที่ถูกปฏิเสธผ่าน Order Rejection API

Why Bulk Submission?

การส่งข้อมูลแบบ Bulk มีข้อดีดังนี้

BenefitDescription
ลดจำนวน API Callsส่งหลายรายการภายใน Request เดียว
เพิ่มประสิทธิภาพลดเวลาในการเชื่อมต่อ
ลดภาระเครือข่ายลดจำนวนการเปิดและปิด Connection
รองรับข้อมูลจำนวนมากเหมาะกับ ERP และ WMS
จัดการผลลัพธ์ได้ง่ายรองรับ Success และ Failed ในแต่ละรายการ

Recommended Client Workflow

text
Collect Orders





Validate Orders





Build Batch





POST /order-checkings





Receive Results



 ┌──────┴────────┐

 │               │

 ▼               ▼

Success      Failed

 │               │

 ▼               ▼

Done      Correct Data





         Retry Failed Orders

Best Practices

  • ตรวจสอบการเชื่อมต่อก่อนเริ่มงานทุกครั้ง
  • Synchronize Master Data อย่างสม่ำเสมอ
  • รวบรวมรายการก่อนส่งเป็น Batch
  • ตรวจสอบข้อมูลจาก Local Database ก่อนเรียก API
  • ตรวจสอบผลลัพธ์ของแต่ละ Order จาก results[]
  • Retry เฉพาะรายการที่ไม่สำเร็จ
  • ใช้ Shipment Tracking API สำหรับติดตามสถานะหลังจากสร้าง Order สำเร็จ

Related Sections

  • 05 Master Data APIs
  • 06 Order Checking APIs
  • 07 Shipment Tracking APIs
  • 10.03 Master Data Synchronization Strategy

Summary

การเรียกใช้งาน SISAHYGO API ตามลำดับที่แนะนำจะช่วยให้ระบบมีประสิทธิภาพและลดข้อผิดพลาดในการเชื่อมต่อ โดยเฉพาะการรวบรวมรายการตรวจรับสินค้าและส่งผ่าน Order Checking API ในรูปแบบ Bulk Submission ซึ่งช่วยลดจำนวน API Calls รองรับการประมวลผลข้อมูลจำนวนมาก และทำให้ Client System สามารถจัดการผลลัพธ์ของแต่ละรายการ รวมถึง Retry เฉพาะรายการที่ล้มเหลวได้อย่างมีประสิทธิภาพ


Next Step

➡️ 10.03 Master Data Synchronization Strategy

SISAHYGO API Integration Guide