Skip to content

06.02 API Endpoint ​


📌 At a Glance ​

รายการรายละเอียด
TopicAPI Endpoint
Difficulty⭐ Beginner
Reading Time5 นาที
TargetDeveloper, System Integrator
API Versionv1.1
HTTP MethodPOST

🎯 Learning Objectives ​

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

  • เข้าใจ Endpoint สำหรับ Order Checking API
  • เข้าใจรูปแบบการเรียกใช้งานทั้งแบบ Single Order และ Bulk Orders
  • เข้าใจการกำหนด HTTP Header และ Authentication
  • ทดสอบ API ผ่าน Postman หรือเครื่องมือ REST Client อื่น ๆ ได้

Overview ​

Order Checking API ใช้สำหรับรับข้อมูลรายการตรวจรับสินค้าจากระบบภายนอกเข้าสู่ SISAHYGO โดยใช้ Endpoint เดียวกันสำหรับการส่งข้อมูลทั้งแบบ Single Order และ Bulk Orders

การออกแบบในลักษณะนี้ช่วยให้การเชื่อมต่อมีความเรียบง่าย ลดความซับซ้อนในการพัฒนา และสามารถรองรับการขยายระบบในอนาคตได้โดยไม่ต้องเปลี่ยนแปลง Endpoint


Figure 6-2 API Endpoint ​

Figure 6-2

Figure 6-2 แสดงโครงสร้างการเรียกใช้งาน Order Checking API ผ่าน Endpoint เดียว ซึ่งรองรับทั้ง Single Order และ Bulk Orders พร้อมขั้นตอนการตรวจสอบสิทธิ์ การตรวจสอบข้อมูล การสร้างรายการตรวจรับสินค้า และการตอบกลับผลการประมวลผลในรูปแบบ JSON


📌 Key Point

Endpoint POST /api/order-checkings รองรับทั้ง Single Order และ Bulk Orders ผ่าน URL เดียว โดยใช้ HTTP POST และ JSON Request ทำให้การพัฒนา Integration มีความง่าย สม่ำเสมอ และลดภาระในการดูแลระบบ


Endpoint Information ​

MethodEndpoint
POST/api/order-checkings

Production ​

text
https://api.sisahygo.online/api/order-checkings

Sandbox ​

text
https://sandbox-api.sisahygo.online/api/order-checkings

Authentication ​

ทุก Request ต้องส่ง API Key ผ่าน HTTP Header

http
POST /api/order-checkings HTTP/1.1
Host: api.sisahygo.online

X-API-Key: your_api_key
Accept: application/json
Content-Type: application/json

Supported Request Types ​

Endpoint นี้รองรับการส่งข้อมูล 2 รูปแบบ

Request TypeDescription
Single Orderส่งรายการตรวจรับสินค้า 1 รายการต่อ Request
Bulk Ordersส่งหลายรายการใน Request เดียว

Client ไม่จำเป็นต้องใช้ Endpoint แยกสำหรับ Bulk Processing


HTTP Request ​

http
POST /api/order-checkings

Body ของ Request อยู่ในรูปแบบ JSON

json
{
    ...
}

รายละเอียดของโครงสร้าง Request จะอธิบายในหัวข้อ 06.03 Request Structure


Required HTTP Headers ​

HeaderRequiredDescription
X-API-Key✅API Key สำหรับ Authentication
Content-Type✅application/json
Accept✅application/json

Response Status ​

API จะตอบกลับด้วย HTTP Status ตามผลการประมวลผล ดังนี้

StatusDescription
201 Createdสร้างรายการสำเร็จ
401 UnauthorizedAPI Key ไม่ถูกต้อง
422 Unprocessable EntityValidation ไม่ผ่าน
500 Internal Server Errorเกิดข้อผิดพลาดภายในระบบ

Processing Flow ​

text
Business Application

        │

        ▼

POST /api/order-checkings

        │

        ▼

Authenticate API Key

        │

        ▼

Validate Request

        │

        ▼

Validate Master Data

        │

        ▼

Create Order Checking

        │

        ▼

Return JSON Response

Endpoint Features ​

FeatureSupported
Single Order✅
Bulk Orders✅
JSON Request✅
JSON Response✅
API Key Authentication✅
Master Data Validation✅
Standard Error Response✅

Postman Testing ​

สามารถทดสอบ Endpoint นี้ผ่าน Postman ได้ โดยกำหนดค่าดังนี้

ParameterValue
MethodPOST
URL/order-checkings
HeaderX-API-Key
BodyJSON

ภายใน Postman Collection แนะนำให้สร้างตัวอย่างแยกเป็น

  • ✅ Create Single Order
  • ✅ Create Bulk Orders

เพื่อให้สะดวกต่อการทดสอบและเปรียบเทียบผลลัพธ์


Best Practices ​

  • ใช้ Endpoint เดียวสำหรับทั้ง Single และ Bulk Orders
  • ส่งข้อมูลผ่าน HTTPS เท่านั้น
  • ตรวจสอบ API Key ก่อนเรียกใช้งาน
  • ใช้ client_reference_no ที่ไม่ซ้ำกันสำหรับแต่ละ Order
  • ตรวจสอบ HTTP Status และ Response ของทุก Request
  • ใช้ Bulk Orders เมื่อต้องส่งข้อมูลจำนวนมากเพื่อลดจำนวน API Calls

Related Sections ​

  • 06.03 Request Structure
  • 06.04 Request Examples
  • 06.05 Response Structure

Summary ​

Order Checking API ใช้ Endpoint เดียว (POST /api/order-checkings) สำหรับรองรับการสร้างรายการตรวจรับสินค้าทั้งแบบ Single Order และ Bulk Orders โดยใช้มาตรฐาน HTTP POST และ JSON พร้อมการยืนยันตัวตนผ่าน API Key การตรวจสอบข้อมูล และการตอบกลับผลการประมวลผลในรูปแบบมาตรฐาน ทำให้ระบบสามารถเชื่อมต่อได้อย่างง่าย มีประสิทธิภาพ และรองรับการขยายระบบในอนาคต


Next Step ​

➡️ 06.03 Request Structure

SISAHYGO API Integration Guide