Skip to content

03.07 HTTP Status Codes


📌 At a Glance

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

🎯 Learning Objectives

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

  • เข้าใจ HTTP Status Code ที่ SISAHYGO API ใช้งาน
  • แยกความแตกต่างระหว่าง Success และ Error
  • จัดการข้อผิดพลาดใน Client System ได้อย่างเหมาะสม

Overview

SISAHYGO API ใช้ HTTP Status Codes ตามมาตรฐาน REST API เพื่อแจ้งผลการประมวลผลของแต่ละ Request

Developer ควรตรวจสอบ HTTP Status Code ก่อนอ่านข้อมูลใน Response Body ทุกครั้ง


Figure 3-7 HTTP Status Codes

(แทรกรูป Figure 3-7 : HTTP Status Codes Reference)

Figure 3-7

Figure 3-7 สรุป HTTP Status Code ที่ใช้ใน SISAHYGO API พร้อมความหมาย สาเหตุที่พบ และแนวทางการจัดการเบื้องต้น


Status Codes

StatusDescriptionใช้เมื่อ
200 OKRequest สำเร็จอ่านหรือสร้างข้อมูลสำเร็จ
400 Bad Requestรูปแบบข้อมูลไม่ถูกต้องValidation ไม่ผ่าน
401 UnauthorizedAPI Key ไม่ถูกต้องAuthentication ล้มเหลว
403 Forbiddenไม่มีสิทธิ์ใช้งานAPI Key ไม่มีสิทธิ์เข้าถึง Endpoint
404 Not Foundไม่พบ ResourceURL หรือข้อมูลไม่ถูกต้อง
422 Unprocessable EntityBusiness Validation Errorข้อมูลถูกต้องแต่ไม่ผ่าน Business Rules
429 Too Many Requestsเรียก API ถี่เกินไปเกิน Rate Limit (รองรับในอนาคต)
500 Internal Server Errorระบบเกิดข้อผิดพลาดServer Error

Typical Response

Success

http
HTTP/1.1 200 OK

Authentication Error

http
HTTP/1.1 401 Unauthorized

Validation Error

http
HTTP/1.1 422 Unprocessable Entity

Server Error

http
HTTP/1.1 500 Internal Server Error

Client Handling Guide

StatusClient ควรทำอย่างไร
200ประมวลผลข้อมูลต่อ
400ตรวจสอบ Request Format
401ตรวจสอบ API Key
403ติดต่อผู้ดูแลระบบ
404ตรวจสอบ Endpoint หรือ Reference
422แก้ไขข้อมูลตาม Error Message
500Retry ภายหลัง หรือแจ้ง Support

Key Points

ItemRecommendation
ตรวจสอบ HTTP Status ก่อน
อ่าน Error Code ใน JSON
อย่าอ้างอิงจาก Message เพียงอย่างเดียว
รองรับ Error ที่ไม่คาดคิด

Implementation Notes

  • ตรวจสอบ HTTP Status Code ก่อนอ่าน response.success
  • กรณี 4xx ควรแจ้งผู้ใช้งานให้แก้ไขข้อมูล
  • กรณี 5xx ควร Retry หรือบันทึก Log เพื่อวิเคราะห์
  • ไม่ควรถือว่า HTTP 200 หมายถึงข้อมูลถูกต้องเสมอ ควรตรวจสอบ success และ code ใน Response Body ร่วมด้วย

Best Practices

  • แยกการจัดการ Error ตาม Status Code
  • บันทึก HTTP Status และ Response Code ใน Log
  • แสดงข้อความที่เหมาะสมแก่ผู้ใช้งาน
  • รองรับ Status Code ใหม่ที่อาจเพิ่มในอนาคต

Summary

HTTP Status Code เป็นตัวบ่งชี้ผลการประมวลผลในระดับ Protocol ขณะที่ JSON Response ให้รายละเอียดเพิ่มเติมในระดับ Business Logic การตรวจสอบทั้งสองส่วนร่วมกันจะช่วยให้ Client System จัดการข้อผิดพลาดได้อย่างถูกต้องและมีประสิทธิภาพ


Next Step

➡️ 03.08 Naming Convention

SISAHYGO API Integration Guide