ข้ามไปยังเนื้อหาหลัก

Omise Postman คอลเลกชัน

คอลเลกชัน Omise Postman อย่างเป็นทางการให้ชุดที่ครบถ้วนของ API ที่กำหนดค่าไว้ล่วงหน้า 100+ จุดปลายทางสำหรับการทดสอบ การพัฒนา และการอัตโนมัติ จัดระเบียบตามประเภททรัพยากร คุณสามารถทดสอบ Omise API ได้อย่างรวดเร็ว แก้ไขปัญหาการรวมตัว และอัตโนมัติเวิร์กโฟลว์การทดสอบ

ภาพรวม​

Postman คืออะไร?​

Postman เป็นแพลตฟอร์มการพัฒนา API ที่นิยมซึ่งทำให้กระบวนการสร้าง ทดสอบ และเอกสาร API ง่ายขึ้น โดยให้:

  • Interactive Request Builder - อินเทอร์เฟสที่ใช้งานง่าย
  • Collection Management - จัดระเบียบคำขอที่เกี่ยวข้อง
  • Environment Variables - จัดการการกำหนดค่า (ทดสอบ, การผลิต)
  • Automated Testing - เขียนและรันการทดสอบ
  • Team Collaboration - แบ่งปันกับสมาชิกทีม
  • CI/CD Integration - รวมเข้ากับ deployment pipelines

การติดตั้ง​

ข้อกำหนดเบื้องต้น​

  • Postman Account - บัญชีฟรีที่ postman.com
  • Omise Account - บัญชีที่มีคีย์ API
  • Postman App - แอปเดสก์ท็อปหรือเวอร์ชันเว็บ

ขั้นตอนการติดตั้ง​

  1. เปิด Postman
  2. คลิกปุ่มนำเข้า
  3. นำเข้าจากสถานที่ทำงาน Omise Postman ที่เป็นทางการ
  4. ตั้งค่าตัวแปรสภาพแวดล้อม (คีย์ API)
  5. เริ่มต้นการทดสอบ

ตั้งค่าตัวแปรสภาพแวดล้อม​

ตัวแปรสภาพแวดล้อมช่วยให้คุณสามารถสลับระหว่างสภาพแวดล้อมการทดสอบและการผลิตได้อย่างง่ายดาย

สร้างสภาพแวดล้อมการทดสอบ​

  1. คลิกไอคอนสภาพแวดล้อม
  2. คลิก "+" เพื่อสร้างสภาพแวดล้อมใหม่
  3. ตั้งชื่อสภาพแวดล้อม - "Omise Test"
  4. เพิ่มตัวแปร:
ตัวแปรประเภทมูลค่า
base_urldefaulthttps://api.omise.co
secret_keysecretskey_test_your_secret_key
public_keydefaultpkey_test_your_public_key
api_versiondefault2019-05-29
  1. บันทึกสภาพแวดล้อม

จุดปลายทางที่พร้อมใช้งาน​

คอลเลกชัน Omise Postman รวมจุดปลายทาง API ทั้งหมดที่จัดระเบียบตามประเภททรัพยากร

ค่าใช้​

จุดปลายทางวิธีคำอธิบาย
List ChargesGETดึงรายการค่าใช้ที่อ้างอิง
Create ChargePOSTสร้างค่าใช้ใหม่
Get ChargeGETดึงค่าใช้เฉพาะ
Update ChargePATCHอัปเดตข้อมูลเมตา
Capture ChargePOSTค่าใช้ที่ได้รับอนุญาต

ลูกค้า​

จุดปลายทางวิธีคำอธิบาย
List CustomersGETรับลูกค้าทั้งหมด
Create CustomerPOSTสร้างลูกค้าใหม่
Get CustomerGETดึงรายละเอียดลูกค้า
Update CustomerPATCHอัปเดตข้อมูลลูกค้า
Delete CustomerDELETEลบลูกค้า

การ์ด​

จุดปลายทางวิธีคำอธิบาย
List CardsGETบัตรลูกค้า
Get CardGETรายละเอียดบัตร
Update CardPATCHอัปเดตข้อมูลบัตร
Delete CardDELETEลบบัตร

การคืนเงิน​

จุดปลายทางวิธีคำอธิบาย
List RefundsGETดึงเงินคืนทั้งหมด
Create RefundPOSTออก refund
Get RefundGETรายละเอียดการคืนเงิน

การทดสอบเวิร์กโฟลว์​

เวิร์กโฟลว์ 1: ลำดับการชำระเงินทั้งหมด​

เวิร์กโฟลว์นี้สาธิตการสร้างและการตรวจสอบค่าใช้

  1. สร้างโทเค็น - โทเค็นข้อมูลบัตร
  2. สร้างค่าใช้ - ใช้โทเค็นสร้างค่าใช้
  3. รับค่าใช้ - ตรวจสอบสำเร็จ
  4. ธุรกรรมรายการ - ประวัติธุรกรรม

การผสานรวม CI/CD​

ใช้ Newman เพื่อรวมการทดสอบ API Omise เข้าไปในไปป์ไลน์ CI/CD

ติดตั้ง Newman​

npm install -g newman

รันการทดสอบ​

newman run omise-collection.json \
  --environment omise-test-env.json \
  --reporters cli,json

ทำความเข้าใจการตรวจสอบสิทธิ์​

Omise ใช้การตรวจสอบสิทธิ์ HTTP Basic ด้วยคีย์ API ของคุณ

วิธีการตรวจสอบสิทธิ์​

ชื่อผู้ใช้: skey_test_your_secret_key รหัสผ่าน: (ว่าง)

การทดสอบการตรวจสอบสิทธิ์​

  1. เลือกคำขอ "Get Balance"
  2. ส่งคำขอ
  3. ตรวจสอบการตอบสนอง (สถานะ 200 OK)

ตัวอย่างคำขอ​

สร้างค่าใช้​

คำขอ:

POST {{base_url}}/charges
Authorization: Basic {{secret_key}}
Content-Type: application/json

{
  "amount": 100000,
  "currency": "THB",
  "card": "tokn_test_5v7h8gp2xqf0v0k4zy7",
  "description": "ค่าใช้ทดสอบ"
}

สร้างลูกค้า​

คำขอ:

POST {{base_url}}/customers
Authorization: Basic {{secret_key}}
Content-Type: application/json

{
  "email": "customer@example.com",
  "description": "ลูกค้า VIP"
}

ข้อเสนอแนะที่ดีที่สุด​

  1. ใช้โหมดทดสอบเสมอ - คีย์ทดสอบในการพัฒนา
  2. จัดระเบียบคำขอ - ใช้โฟลเดอร์และป้ายกำกับ
  3. เขียนการทดสอบ - ยืนยันการตอบสนอง
  4. ใช้ตัวแปรสภาพแวดล้อม - ลดการทำซ้ำ
  5. จัดเก็บในเวอร์ชัน - ติดตามการเปลี่ยนแปลง

คำถามที่พบบ่อย​

มี endpoint ทั้งหมดกี่ใน Omise Postman Collection?

100+ endpoints (Charges, Customers, Cards, Refunds, Transfers เป็นต้น)

ฉันสามารถใช้ Postman ในการผลิตได้หรือไม่?

ใช่ แต่ระมัดระวัง ตั้งค่าสภาพแวดล้อมแยกต่างหากสำหรับทดสอบและการผลิต

Newman คืออะไร?

Command-line collection runner ของ Postman สำหรับ CI/CD

ทรัพยากรที่เกี่ยวข้อง​

ขั้นตอนต่อไป​

  1. นำเข้าคอลเลกชัน
  2. ตั้งค่าตัวแปรสภาพแวดล้อม
  3. ทดสอบด้วยคีย์ทดสอบ
  4. สลับไปยังคีย์สด
  5. รวมเข้ากับ CI/CD