โมเดลข้อมูล
Less than 1 minute
ภาพรวมโมเดลข้อมูล
ส่วนนี้ให้เอกสารที่ครอบคลุมสำหรับโมเดลข้อมูลทั้งหมดที่ใช้ในระบบ API Smilepayz โมเดลข้อมูลกำหนดโครงสร้างและรูปแบบของพารามิเตอร์คำขอและการตอบกลับ เพื่อให้แน่ใจว่าการสื่อสาร API มีความสม่ำเสมอและเชื่อถือได้
โมเดลข้อมูลหลัก
ลำดับ | ชื่อโมเดล | คำอธิบาย |
---|---|---|
1 | Money Model | ข้อกำหนดสกุลเงินและจำนวนเงินสำหรับธุรกรรม คุณสมบัติ: รองรับหลายสกุลเงิน การจัดการความแม่นยำ องค์ประกอบ: currency, amount, payAmount |
2 | Merchant Model | ข้อมูลการระบุตัวตนและลำดับชั้นของพ่อค้า คุณสมบัติ: รองรับพ่อค้าหลักและพ่อค้าย่อย องค์ประกอบ: merchantId, merchantName, subMerchantId |
3 | Payer Model | ข้อมูลลูกค้าสำหรับธุรกรรม Pay-in คุณสมบัติ: ข้อกำหนดการระบุตัวตนตามภูมิภาค องค์ประกอบ: name, email, phone, idType, identity |
4 | Receiver Model | ข้อมูลผู้รับสำหรับธุรกรรม Pay-out คุณสมบัติ: ข้อกำหนดการปฏิบัติตามกฎระเบียบตามภูมิภาค องค์ประกอบ: name, email, phone, idType, identity, taxNumber |
5 | Payment Channel Model | ข้อมูลวิธีการชำระเงินและการประมวลผล คุณสมบัติ: รองรับวิธีการชำระเงินหลายแบบ องค์ประกอบ: paymentMethod, paymentUrl, qrString, vaNumber |
6 | Transaction Status Model | คำจำกัดความสถานะวงจรชีวิตธุรกรรม คุณสมบัติ: การติดตามและติดตามสถานะ องค์ประกอบ: INIT, PROCESSING, SUCCESS, FAILED, EXPIRED |
7 | Trade Type Model | การจำแนกประเภทธุรกรรม คุณสมบัติ: การแยกแยะ Pay-in และ Pay-out องค์ประกอบ: Pay-In (1), Pay-Out (2) |
8 | Item Detail Model | ข้อมูลผลิตภัณฑ์และบริการ คุณสมบัติ: ข้อกำหนดและราคาสินค้า องค์ประกอบ: name, quantity, price |
9 | Area Model | ข้อกำหนดภูมิภาคและเครือข่าย คุณสมบัติ: รองรับภูมิศาสตร์และคริปโตเคอร์เรนซี องค์ประกอบ: รหัสภูมิภาค การแมปสกุลเงิน |
หมวดหมู่โมเดล
Transaction Models
โมเดลที่ออกแบบมาเฉพาะสำหรับการประมวลผลธุรกรรมทางการเงิน:
- Money Model: การจัดการสกุลเงินและจำนวนเงิน
- Trade Type Model: การจำแนกประเภทธุรกรรม
- Transaction Status Model: การติดตามสถานะ
Entity Models
โมเดลสำหรับการระบุและจัดการองค์กรธุรกิจ:
- Merchant Model: การระบุตัวตนและลำดับชั้นของพ่อค้า
- Payer Model: ข้อมูลลูกค้า
- Receiver Model: ข้อมูลผู้รับ
Processing Models
โมเดลสำหรับการประมวลผลและเส้นทางการชำระเงิน:
- Payment Channel Model: ข้อกำหนดวิธีการชำระเงิน
- Area Model: การสนับสนุนภูมิภาคและเครือข่าย
- Item Detail Model: รายละเอียดผลิตภัณฑ์และบริการ
ลักษณะของโมเดลข้อมูล
การมาตรฐาน
- รูปแบบที่สม่ำเสมอ: โมเดลทั้งหมดปฏิบัติตามรูปแบบ JSON มาตรฐาน
- ความปลอดภัยของประเภท: ข้อกำหนดประเภทข้อมูลที่ชัดเจนสำหรับพารามิเตอร์ทั้งหมด
- กฎการตรวจสอบ: ข้อกำหนดการตรวจสอบที่ครอบคลุม
- เอกสาร: เอกสารพารามิเตอร์และตัวอย่างที่สมบูรณ์
การสนับสนุนภูมิภาค
- หลายภูมิภาค: รองรับหลายประเทศและตลาด
- การปฏิบัติตามท้องถิ่น: ข้อกำหนดการปฏิบัติตามกฎระเบียบตามภูมิภาค
- การสนับสนุนสกุลเงิน: การประมวลผลธุรกรรมหลายสกุลเงิน
- วิธีการชำระเงิน: การสนับสนุนช่องทางการชำระเงินเฉพาะภูมิภาค
คุณสมบัติความปลอดภัย
- การเข้ารหัสข้อมูล: การเข้ารหัสข้อมูลที่ละเอียดอ่อนในการส่ง
- การควบคุมการเข้าถึง: การควบคุมการเข้าถึงตามบทบาทสำหรับโมเดลข้อมูล
- ประวัติการตรวจสอบ: ประวัติการตรวจสอบที่สมบูรณ์สำหรับการใช้งานโมเดลข้อมูล
- การปกป้องความเป็นส่วนตัว: การปฏิบัติตาม GDPR และกฎหมายความเป็นส่วนตัวตามภูมิภาค
แนวทางการใช้งาน
การใช้งานโมเดล
- Request Models: ใช้สำหรับการตรวจสอบพารามิเตอร์คำขอ API
- Response Models: ใช้สำหรับการจัดรูปแบบข้อมูลการตอบกลับ API
- การตรวจสอบ: การตรวจสอบพารามิเตอร์และการจัดการข้อผิดพลาดที่ครอบคลุม
- เอกสาร: เอกสารโมเดลที่สมบูรณ์พร้อมตัวอย่าง
แนวทางปฏิบัติที่ดีที่สุด
- การตั้งชื่อที่สม่ำเสมอ: ข้อตกลงการตั้งชื่อมาตรฐานในโมเดลทั้งหมด
- การตรวจสอบประเภท: การตรวจสอบประเภทข้อมูลที่เข้มงวดสำหรับพารามิเตอร์ทั้งหมด
- การจัดการข้อผิดพลาด: การจัดการข้อผิดพลาดที่ครอบคลุมสำหรับข้อมูลที่ไม่ถูกต้อง
- ประสิทธิภาพ: โครงสร้างโมเดลที่ปรับให้เหมาะสมสำหรับการประมวลผลที่มีประสิทธิภาพ
การสนับสนุนการรวม
- การรวม SDK: การสนับสนุน SDK เต็มรูปแบบสำหรับโมเดลข้อมูลทั้งหมด
- ตัวอย่างโค้ด: ตัวอย่างการใช้งานที่สมบูรณ์
- การทดสอบ: กรอบการทดสอบที่ครอบคลุมสำหรับการตรวจสอบโมเดล
- เอกสาร: คู่มือและบทเรียนการรวมที่ละเอียด
การพัฒนาของโมเดล
การจัดการเวอร์ชัน
- ความเข้ากันได้ย้อนหลัง: รักษาความเข้ากันได้ย้อนหลังสำหรับโมเดลที่มีอยู่
- การควบคุมเวอร์ชัน: กลยุทธ์การจัดการเวอร์ชันที่ชัดเจนสำหรับการอัปเดตโมเดล
- การสนับสนุนการย้าย: คู่มือการย้ายสำหรับการเปลี่ยนแปลงโมเดล
- นโยบายการเลิกใช้: นโยบายการเลิกใช้และยกเลิกที่ชัดเจน
กระบวนการการปรับปรุง
- คำขอคุณสมบัติ: กระบวนการที่มีโครงสร้างสำหรับคำขอการปรับปรุงโมเดล
- กระบวนการตรวจสอบ: กระบวนการตรวจสอบที่ครอบคลุมสำหรับการเปลี่ยนแปลงโมเดล
- การทดสอบ: การทดสอบอย่างกว้างขวางสำหรับการปรับเปลี่ยนโมเดล
- เอกสาร: เอกสารที่อัปเดตสำหรับการเปลี่ยนแปลงโมเดลทั้งหมด