Skip to content

Chapter 9

Error Handling & Response Codes


09.01 Error Handling Overview


📌 At a Glance

รายการรายละเอียด
TopicError Handling Overview
Difficulty⭐ Beginner
Reading Time8 นาที
TargetDeveloper, System Integrator
Related APIsAll APIs

🎯 Learning Objectives

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

  • เข้าใจหลักการจัดการข้อผิดพลาดของ SISAHYGO API
  • แปลความหมายของ HTTP Status Codes ได้
  • แยกแยะข้อผิดพลาดจากการตรวจสอบข้อมูลและข้อผิดพลาดของระบบ
  • ออกแบบ Client System ให้รองรับการจัดการข้อผิดพลาดได้อย่างเหมาะสม

Overview

ทุก API ของ SISAHYGO ใช้มาตรฐาน HTTP Status Codes และ JSON Response เพื่อสื่อสารผลการทำงานระหว่าง Client System และ Server

เมื่อการเรียก API สำเร็จ ระบบจะส่งข้อมูลกลับพร้อม HTTP Status Code ที่เหมาะสม เช่น 200 OK หรือ 201 Created

ในกรณีที่เกิดข้อผิดพลาด ระบบจะส่ง HTTP Status Code พร้อมรายละเอียดของข้อผิดพลาด เพื่อให้ Client System สามารถวิเคราะห์สาเหตุ แจ้งผู้ใช้งาน และดำเนินการแก้ไขได้อย่างถูกต้อง

การออกแบบระบบให้รองรับ Error Handling อย่างเหมาะสม จะช่วยเพิ่มความน่าเชื่อถือของการเชื่อมต่อและลดผลกระทบจากข้อผิดพลาดที่อาจเกิดขึ้นระหว่างการทำงาน


Figure 9-1 Error Handling Overview

Figure 9-1

Figure 9-1 แสดงภาพรวมของการจัดการข้อผิดพลาดในการสื่อสารระหว่าง Client System และ SISAHYGO API ตั้งแต่การส่ง Request การประมวลผล การตอบกลับด้วย HTTP Status Code และการจัดการผลลัพธ์ในฝั่ง Client


Error Handling Workflow

text
Client System





API Request





SISAHYGO API



        ├────────────► Success

        │                  │

        │                  ▼

        │            HTTP 200 / 201





Error





HTTP Status Code





JSON Error Response





Client Error Handling

Error Categories

ข้อผิดพลาดสามารถแบ่งออกได้เป็น 4 กลุ่มหลัก

CategoryDescription
AuthenticationAPI Key ไม่ถูกต้องหรือไม่ได้รับอนุญาต
Validationข้อมูลที่ส่งมาไม่ผ่านการตรวจสอบ
Business Rulesข้อมูลไม่เป็นไปตามเงื่อนไขของกระบวนการธุรกิจ
Server Errorsข้อผิดพลาดภายในระบบหรือบริการไม่พร้อมใช้งาน

Error Handling Principles

Client System ควรปฏิบัติตามหลักการดังต่อไปนี้

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

Common Error Flow

text
Request





Receive HTTP Status



      ├────────► 2xx

      │             │

      │             ▼

      │        Continue Process





4xx / 5xx





Read Error Message





Handle Error





Retry or Correct Data

Related Topics

ในบทนี้จะอธิบายหัวข้อต่อไปนี้

SectionDescription
9.2HTTP Status Codes
9.3Standard Error Response Format
9.4Authentication Errors
9.5Validation Errors
9.6Error Handling Best Practices
9.7Chapter Summary

Best Practices

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

Related Chapters

ChapterDescription
Chapter 5Master Data APIs
Chapter 6Order Checking APIs
Chapter 7Shipment Tracking APIs
Chapter 8Order Rejection APIs

Summary

Error Handling เป็นองค์ประกอบสำคัญของการพัฒนา Integration ที่มีความเสถียร การทำความเข้าใจ HTTP Status Codes รูปแบบ Error Response และแนวทางการจัดการข้อผิดพลาด จะช่วยให้ Client System สามารถตอบสนองต่อสถานการณ์ต่าง ๆ ได้อย่างถูกต้อง ลดผลกระทบต่อผู้ใช้งาน และเพิ่มความน่าเชื่อถือของระบบโดยรวม


Next Step

➡️ 09.02 HTTP Status Codes

SISAHYGO API Integration Guide