กระบวนการบูรณาการ
ภาพรวมการบูรณาการ
คู่มือการบูรณาการที่ครอบคลุมนี้ให้คำแนะนำทีละขั้นตอนสำหรับการบูรณาการกับแพลตฟอร์มการชำระเงิน Smilepayz กระบวนการบูรณาการได้รับการออกแบบให้เรียบง่ายและปลอดภัย รองรับหลายภูมิภาคและวิธีการชำระเงิน
ข้อกำหนดเบื้องต้นและการตั้งค่าบัญชี
เอกสาร API ตามภูมิภาค
เลือกภูมิภาคเป้าหมายของคุณเพื่อเข้าถึงเอกสาร API เฉพาะ:
ภูมิภาค | ลิงก์เอกสาร | สกุลเงิน | วิธีการชำระเงิน |
---|---|---|---|
บราซิล | เอกสาร API บราซิล | BRL | PIX, โอนเงินผ่านธนาคาร |
ชิลี | เอกสาร API ชิลี | CLP | CASHIER_CL, โอนเงินผ่านธนาคาร |
โคลอมเบีย | เอกสาร API โคลอมเบีย | COP | CASHIER_CO, โอนเงินผ่านธนาคาร |
อินเดีย | เอกสาร API อินเดีย | INR | UPI, โอนเงินผ่านธนาคาร |
อินโดนีเซีย | เอกสาร API อินโดนีเซีย | IDR | QRIS, บัญชีเสมือน |
เม็กซิโก | เอกสาร API เม็กซิโก | MXN | SPEI, โอนเงินผ่านธนาคาร |
เปรู | เอกสาร API เปรู | PEN | CASHIER_PE, โอนเงินผ่านธนาคาร |
ฟิลิปปินส์ | เอกสาร API ฟิลิปปินส์ | PHP | GCASH, โอนเงินผ่านธนาคาร |
ไทย | เอกสาร API ไทย | THB | QRPAY, โอนเงินผ่านธนาคาร |
การได้มาซึ่งบัญชี
- ติดต่อพนักงาน Smilepayz: กรุณาติดต่อทีมพัฒนาธุรกิจของเราเพื่อรับบัญชีบูรณาการของคุณ
- การยืนยันบัญชี: ทำกระบวนการยืนยันตัวตนของร้านค้าให้เสร็จสิ้น
- การเข้าถึงเอกสาร: รับการเข้าถึงเอกสาร API ตามภูมิภาคและข้อมูลประจำตัว
การบูรณาการสภาพแวดล้อม Sandbox
สภาพแวดล้อม sandbox ให้สภาพแวดล้อมการทดสอบที่ปลอดภัยพร้อมข้อมูลจำลองสำหรับการพัฒนาและการทดสอบบูรณาการ
ขั้นตอนที่ 1: ดึงข้อมูลบูรณาการ
เข้าถึง Merchant Backend
- เข้าสู่ระบบ: เข้าถึงพอร์ทัล Merchant Backend
- สลับสภาพแวดล้อม: สลับไปที่แท็บ Sandbox
- ดึงข้อมูลประจำตัว: รับข้อมูลประจำตัว sandbox ของคุณ
ข้อมูลประจำตัว Sandbox
- Merchant ID: ขึ้นต้นด้วยคำนำหน้า
sandbox
ในสภาพแวดล้อม sandbox - Merchant Secret: ใช้สำหรับการสร้างลายเซ็น (ห้ามแก้ไข)
- Platform Public Key: สำหรับการตรวจสอบลายเซ็น
หมายเหตุสำคัญ
ข้อมูลประจำตัว Sandbox ใช้สำหรับการทดสอบเท่านั้นและไม่สามารถใช้ในการผลิตได้
ขั้นตอนที่ 2: กำหนดค่า IP Whitelist และ Callback URL
การกำหนดค่า IP Whitelist
- การกำหนดค่าเอง: กำหนดค่า IP whitelist อย่างอิสระใน sandbox
- คู่มืออ้างอิง: ดูการกำหนดค่า IP Sandbox
- IP การพัฒนา: เพิ่มที่อยู่ IP ของเซิร์ฟเวอร์การพัฒนาของคุณ
การตั้งค่า Callback URL
- การกำหนดค่า Backend: กำหนดค่า callback URL ในMerchant Backend
- พารามิเตอร์คำขอ: หรือรวม
callbackUrl
ในพารามิเตอร์คำขอ API - ต้องใช้ HTTPS: ตรวจสอบให้แน่ใจว่า callback URL ใช้โปรโตคอล HTTPS
ขั้นตอนที่ 3: สร้างคู่คีย์ RSA
กระบวนการสร้างคีย์
- สร้างคีย์: คลิกปุ่มสร้างคีย์ RSA
- การสร้างคู่คีย์: ระบบสร้างคีย์ส่วนตัว RSA และคีย์สาธารณะ
- บันทึกคีย์สาธารณะ: ตรวจสอบให้แน่ใจว่าคีย์สาธารณะถูกบันทึกสำเร็จ
- การตรวจสอบ: รีเฟรชหน้าเพื่อยืนยันว่าคีย์สาธารณะถูกบันทึกแล้ว
การตรวจสอบคู่คีย์
- การจับคู่: ตรวจสอบว่าคีย์สาธารณะที่บันทึกตรงกับคีย์ส่วนตัวของคุณ
- ข้อผิดพลาดลายเซ็น: คู่คีย์ที่ไม่ตรงกันจะทำให้การตรวจสอบลายเซ็นล้มเหลว
- ความปลอดภัยของคีย์: เก็บคีย์ส่วนตัวของคุณอย่างปลอดภัยและอย่าแชร์
คำเตือนความปลอดภัย
ตรวจสอบให้แน่ใจว่าคีย์สาธารณะที่บันทึกตรงกับคู่เดียวกับคีย์ส่วนตัวที่ใช้สำหรับการเซ็น คีย์ที่ไม่ตรงกันจะทำให้เกิดข้อผิดพลาดลายเซ็น
ขั้นตอนที่ 4: การดำเนินการบูรณาการ API
การกำหนดค่า Base URL
- Sandbox Base URL:
https://sandbox-gateway.smilepayz.com
- เวอร์ชัน API: ใช้ endpoint API v2.0
- ใช้ HTTPS เท่านั้น: การสื่อสาร API ทั้งหมดใช้ HTTPS
การบูรณาการ SDK
เราให้ SDK ที่ครอบคลุมในหลายภาษาโปรแกรมมิ่ง:
ภาษา | Repository | เอกสาร |
---|---|---|
Java | Java Demo | การดำเนินการ Java ที่สมบูรณ์ |
C# | C# Demo | ตัวอย่างการบูรณาการ .NET |
PHP | PHP SDK | PHP SDK และตัวอย่าง |
Python | Python Demo | คู่มือการบูรณาการ Python |
Node.js | Node.js Demo | ตัวอย่าง JavaScript/Node.js |
Golang | Golang Demo | การบูรณาการภาษา Go |
ข้อกำหนดการกำหนดค่า
- การแทนที่ข้อมูลประจำตัว: แทนที่
merchant ID
,merchant secret
, และprivate key
ด้วยข้อมูลประจำตัวจริงของคุณ - ตัวแปรสภาพแวดล้อม: ใช้ตัวแปรสภาพแวดล้อมสำหรับการกำหนดค่าที่ละเอียดอ่อน
- การจัดการข้อผิดพลาด: ดำเนินการจัดการข้อผิดพลาดที่ครอบคลุม
ขั้นตอนที่ 5: การสร้างคำสั่งซื้อและการจัดการการตอบสนอง
การประมวลผลการตอบสนองที่สำเร็จ
- รหัสสำเร็จ:
code = "00"
หมายถึงการสร้างคำสั่งซื้อสำเร็จ - URL การชำระเงิน: ข้อมูลจำลองใน sandbox (ไม่ใช่สำหรับการชำระเงินจริง)
- หมายเลขคำสั่งซื้อ: ตัวระบุคำสั่งซื้อที่ไม่ซ้ำกันสำหรับการติดตาม
ตัวอย่างการตอบสนองที่สำเร็จ
{
"code": "00",
"channel": {
"paymentUrl": "https://sandbox-gateway.smilepayz.com/cashier/#/loading?tradeNo=T1112001925061115234920979"
},
"orderNo": "S200192eeacf6ed4f74406900c8f1039",
"responseCode": "2009000",
"message": "Success"
}
การทดสอบ Callback ใน Sandbox
- Callback แบบมือ: ใน sandbox คุณสามารถเริ่มคำขอ callback ด้วยตนเอง
- สถานการณ์การทดสอบ: ทดสอบสถานการณ์การชำระเงินต่างๆ และการอัปเดตสถานะ
- การจำลองข้อผิดพลาด: ทดสอบการจัดการข้อผิดพลาดและกรณีขอบ
ขั้นตอนที่ 6: การประมวลผลคำขอ Callback
การตรวจสอบลายเซ็น
- ดึงคีย์สาธารณะ: รับคีย์สาธารณะของแพลตฟอร์มใน sandbox
- การตรวจสอบลายเซ็น: ตรวจสอบลายเซ็น callback ของ Smilepayz
- การยืนยันการตอบสนอง: ส่งคืน
SUCCESS
ให้ Smilepayz
ความปลอดภัยของ Callback
- การตรวจสอบลายเซ็น: ตรวจสอบลายเซ็น callback เสมอ
- การตรวจสอบคำขอ: ตรวจสอบพารามิเตอร์ callback ทั้งหมด
- การจัดการการตอบสนอง: ดำเนินการจัดการการตอบสนองที่เหมาะสม
การบูรณาการสภาพแวดล้อมการผลิต
สภาพแวดล้อมการผลิตจัดการธุรกรรมจริงและต้องการมาตรการความปลอดภัยเพิ่มเติม
ขั้นตอนที่ 1: การตั้งค่าข้อมูลประจำตัวการผลิต
ความแตกต่างของสภาพแวดล้อม
- ข้อมูลประจำตัวแยก: ข้อมูลประจำตัวการผลิตแตกต่างจาก sandbox อย่างสิ้นเชิง
- พอร์ทัลการเข้าถึง: เข้าสู่ระบบMerchant Backend และสลับไปที่แท็บ Production
- ประเภทข้อมูลประจำตัว:
- Merchant ID: ตัวระบุเฉพาะการผลิต
- Merchant Secret: ความลับการผลิตสำหรับการสร้างลายเซ็น
- Platform Public Key: คีย์สาธารณะการผลิตสำหรับการตรวจสอบ
ความปลอดภัยการผลิต
ข้อมูลบูรณาการการผลิตแตกต่างจาก sandbox อย่างสิ้นเชิง อย่าใช้ข้อมูลประจำตัว sandbox ในการผลิต
ขั้นตอนที่ 2: การกำหนดค่า IP Whitelist และ Callback
การจัดการ IP Whitelist
- ข้อกำหนดความปลอดภัย: ร้านค้าไม่สามารถตั้งค่า IP whitelist อย่างอิสระได้
- ติดต่อฝ่ายสนับสนุน: ติดต่อฝ่ายบริการลูกค้าสำหรับการกำหนดค่า IP whitelist
- การตรวจสอบความปลอดภัย: ที่อยู่ IP ทั้งหมดผ่านการตรวจสอบความปลอดภัย
การกำหนดค่า Callback URL
- การตั้งค่า Backend: กำหนดค่า callback URL ในMerchant Backend
- พารามิเตอร์คำขอ: รวม
callbackUrl
ในพารามิเตอร์คำขอ API - ต้องใช้ HTTPS: Callback URL การผลิตทั้งหมดต้องใช้ HTTPS
ขั้นตอนที่ 3: การสร้างคีย์ RSA การผลิต
กระบวนการสร้างคีย์
- สร้างคีย์: คลิกปุ่มสร้างคีย์ RSA
- การสร้างคู่คีย์: สร้างคีย์ส่วนตัวและคีย์สาธารณะ RSA การผลิต
- บันทึกคีย์สาธารณะ: ตรวจสอบให้แน่ใจว่าคีย์สาธารณะถูกบันทึกสำเร็จ
- การตรวจสอบ: รีเฟรชหน้าเพื่อยืนยันว่าคีย์สาธารณะถูกบันทึกแล้ว
ความปลอดภัยของคีย์การผลิต
- การจับคู่คีย์: ตรวจสอบว่าคีย์สาธารณะที่บันทึกตรงกับคีย์ส่วนตัวของคุณ
- การจัดเก็บที่ปลอดภัย: ดำเนินการปฏิบัติการจัดเก็บคีย์ที่ปลอดภัย
- การหมุนเวียนคีย์: วางแผนสำหรับการหมุนเวียนคีย์เป็นระยะ
ขั้นตอนที่ 4: การบูรณาการ API การผลิต
Base URL การผลิต
- Production Base URL:
https://gateway.smilepayz.com
- เวอร์ชัน API: ใช้ endpoint API v2.0
- ใบรับรอง SSL: ต้องมีใบรับรอง SSL ที่ถูกต้อง
การดำเนินการ SDK
ใช้ repository SDK เดียวกับ sandbox แต่ใช้ข้อมูลประจำตัวการผลิต:
ภาษา | Repository | หมายเหตุการผลิต |
---|---|---|
Java | Java Demo | การดำเนินการที่พร้อมสำหรับการผลิต |
C# | C# Demo | ตัวอย่างการผลิต .NET |
PHP | PHP SDK | PHP SDK การผลิต |
Python | Python Demo | คู่มือ Python การผลิต |
Node.js | Node.js Demo | ตัวอย่าง Node.js การผลิต |
Golang | Golang Demo | การบูรณาการ Go การผลิต |
ขั้นตอนที่ 5: การประมวลผลคำสั่งซื้อการผลิต
การจัดการการตอบสนองการผลิต
- ธุรกรรมจริง: การผลิตต้องการการชำระเงินจริงหรือการจ่ายเงินที่สำเร็จ
- รหัสสำเร็จ:
code = "00"
หมายถึงการสร้างคำสั่งซื้อสำเร็จ - URL การชำระเงิน: URL checkout Smilepayz จริงสำหรับการชำระเงินของลูกค้า
- ความแตกต่างตามภูมิภาค:
channel
ที่ส่งคืนแตกต่างกันตามภูมิภาค
ตัวอย่างการตอบสนองการผลิต
{
"code": "00",
"channel": {
"paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=T1112001925061115234920979"
},
"orderNo": "200192eeacf6ed4f74406900c8f1039",
"responseCode": "2009000",
"message": "Success"
}
ข้อมูลช่องทางตามภูมิภาค
- ความแตกต่างของช่องทาง: ช่องทางการชำระเงินที่แตกต่างกันตามภูมิภาค
- เอกสารอ้างอิง: ดูโมเดลช่องทางการชำระเงิน
- การปฏิบัติตามภูมิภาค: ตรวจสอบให้แน่ใจว่าปฏิบัติตามข้อกำหนดของภูมิภาค
ขั้นตอนที่ 6: การประมวลผล Callback การผลิต
การตรวจสอบ Callback
- ดึงคีย์สาธารณะ: รับคีย์สาธารณะของแพลตฟอร์มการผลิต
- การตรวจสอบลายเซ็น: ตรวจสอบลายเซ็น callback ของ Smilepayz
- การยืนยันการตอบสนอง: ส่งคืน
SUCCESS
ให้ Smilepayz
ความปลอดภัยของ Callback การผลิต
- การตรวจสอบลายเซ็น: การตรวจสอบลายเซ็นบังคับสำหรับ callback ทั้งหมด
- การตรวจสอบคำขอ: การตรวจสอบพารามิเตอร์ที่ครอบคลุม
- การจัดการข้อผิดพลาด: การจัดการข้อผิดพลาดและการบันทึกที่แข็งแกร่ง
- การติดตาม: ดำเนินการติดตามและแจ้งเตือน callback
แนวทางปฏิบัติที่ดีที่สุดสำหรับการบูรณาการ
แนวทางความปลอดภัย
- การจัดการข้อมูลประจำตัว: การจัดเก็บข้อมูลประจำตัว API ทั้งหมดอย่างปลอดภัย
- การตรวจสอบลายเซ็น: ตรวจสอบลายเซ็นคำขอและการตอบสนองเสมอ
- ใช้ HTTPS เท่านั้น: ใช้ HTTPS สำหรับการสื่อสาร API ทั้งหมด
- IP Whitelisting: จำกัดการเข้าถึงเฉพาะที่อยู่ IP ที่ได้รับอนุญาต
การจัดการข้อผิดพลาด
- การบันทึกที่ครอบคลุม: บันทึกคำขอและตอบสนอง API ทั้งหมด
- การกู้คืนข้อผิดพลาด: ดำเนินการกลไกการลองใหม่สำหรับข้อผิดพลาดชั่วคราว
- การติดตาม: ตั้งค่าการติดตามและแจ้งเตือนสำหรับสุขภาพการบูรณาการ
- การทดสอบ: การทดสอบอย่างละเอียดใน sandbox ก่อนการปรับใช้การผลิต
การเพิ่มประสิทธิภาพประสิทธิภาพ
- Connection Pooling: ดำเนินการ connection pooling สำหรับการเรียก API
- การแคช: แคชข้อมูลสถิตที่เหมาะสม
- การประมวลผลแบบ Async: ใช้การประมวลผลแบบอะซิงโครนัสสำหรับ callback
- การทดสอบโหลด: ดำเนินการทดสอบโหลดก่อนการปรับใช้การผลิต
การสนับสนุนและทรัพยากร
การสนับสนุนทางเทคนิค
- สนับสนุน 24/7: การสนับสนุนทางเทคนิคตลอด 24 ชั่วโมง
- ความช่วยเหลือการบูรณาการ: คำแนะนำจากผู้เชี่ยวชาญสำหรับการบูรณาการที่ซับซ้อน
- เอกสาร: เอกสาร API และคู่มือที่ครอบคลุม
- ชุมชน: ชุมชนนักพัฒนาและฟอรัม
ทรัพยากรการทดสอบ
- สภาพแวดล้อม Sandbox: สภาพแวดล้อมการทดสอบที่สมบูรณ์พร้อมข้อมูลจำลอง
- สถานการณ์การทดสอบ: สถานการณ์การทดสอบและกรณีขอบที่ครอบคลุม
- ข้อมูลจำลอง: ข้อมูลจำลองที่สมจริงสำหรับการทดสอบ
- เครื่องมือการตรวจสอบ: เครื่องมือสำหรับการตรวจสอบลายเซ็นและการทดสอบ
การปฏิบัติตามและความปลอดภัย
- การปฏิบัติตามภูมิภาค: การปฏิบัติตามกฎระเบียบการชำระเงินของภูมิภาค
- มาตรฐานความปลอดภัย: การปฏิบัติความปลอดภัยตามมาตรฐานอุตสาหกรรม
- การสนับสนุนการตรวจสอบ: การสนับสนุนสำหรับการตรวจสอบความปลอดภัยและการตรวจสอบการปฏิบัติตาม
- การรับรอง: การรับรองความปลอดภัยและเอกสารการปฏิบัติตาม