Skip to content

03.04 HTTP Methods


📌 At a Glance

รายการรายละเอียด
TopicHTTP Methods
Difficulty⭐ Beginner
Reading Time5 นาที
TargetDeveloper

🎯 Learning Objectives

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

  • เข้าใจ HTTP Methods ที่ SISAHYGO API ใช้งาน
  • เลือกใช้ Method ได้ถูกต้อง
  • เข้าใจข้อจำกัดของแต่ละ Method

Overview

SISAHYGO API V1.1 ใช้มาตรฐาน HTTP Methods ตามแนวทาง REST API

ในเวอร์ชันปัจจุบัน มีการใช้งานเพียง GET และ POST ซึ่งครอบคลุมกระบวนการเชื่อมต่อทั้งหมดระหว่าง Client System และ SISAHYGO


Figure 3-4 HTTP Methods

(แทรกรูป Figure 3-4 : HTTP Methods Matrix)

Figure 3-4

Figure 3-4 แสดงการแบ่งประเภทของ HTTP Methods ที่รองรับใน SISAHYGO API พร้อมตัวอย่าง Endpoint และวัตถุประสงค์การใช้งาน


Supported Methods

MethodPurposeExample
GETอ่านข้อมูล/products
POSTสร้างข้อมูล/order-checkings

Endpoint Mapping

EndpointMethodDescription
/productsGETดึงข้อมูลรายการสินค้า
/receiversGETดึงข้อมูลผู้รับ
/shipmentsGETติดตามสถานะการขนส่ง
/order-rejectionsGETตรวจสอบรายการที่ถูก Reject
/order-checkingsPOSTสร้างรายการตรวจรับสินค้า

Methods Not Supported

HTTP Methods ต่อไปนี้ยังไม่เปิดให้บริการใน API V1.1

MethodStatus
PUTNot Supported
PATCHNot Supported
DELETENot Supported

หากมีการเปิดให้บริการในอนาคต จะประกาศใน Release Notes ของ API Version ใหม่


Key Points

MethodSafeIdempotent
GET
POST

Implementation Notes

  • ใช้ GET สำหรับอ่านข้อมูลเท่านั้น
  • ใช้ POST สำหรับสร้าง Transaction ใหม่
  • ไม่ควรใช้ GET เพื่อส่งข้อมูลที่มีผลต่อ Business Logic
  • ทุก Request ต้องส่งผ่าน HTTPS

Best Practices

  • ใช้ HTTP Method ให้ตรงกับวัตถุประสงค์
  • ตรวจสอบ HTTP Status Code ทุกครั้ง
  • ไม่ใช้ Query String สำหรับข้อมูลจำนวนมาก
  • กำหนด Content-Type: application/json สำหรับทุก POST Request

Summary

SISAHYGO API V1.1 รองรับ HTTP Methods เพียง 2 ประเภท ได้แก่ GET และ POST ซึ่งเพียงพอสำหรับการเชื่อมต่อกับ Client System และช่วยให้ API มีความเรียบง่าย เรียนรู้ได้ง่าย และดูแลรักษาได้สะดวก


Next Step

➡️ 03.05 Request Format

SISAHYGO API Integration Guide