เตรียมตัวให้พร้อมเพื่อใช้ API
1. สร้างบัญชี Brick
หากต้องการเริ่มใช้ APIs ของ Brick คุณจะต้องสร้างบัญชี หากคุณยังไม่ได้ลงทะเบียน กรุณาลงทะเบียนที่นี่ https://app.onebrick.io/signup
2. รับข้อมูลรับรอง API ไคลเอ็นต์ของคุณ
ไปที่ส่วน 'การกำหนดค่า' และตรวจสอบภายใต้แท็บ 'ข้อมูลประจำตัว API' คุณจะพบ Client ID และ Client Secret ของคุณอยู่ที่นั่น
3. กำหนดค่า URL โทรกลับ
API v2 ของ Brick ใช้กลไกการโทรกลับเพื่อแจ้งเตือนแอปพลิเคชันของคุณเกี่ยวกับเหตุการณ์ต่างๆ จำเป็นต้องตั้งค่า URL โทรกลับที่เหมาะสมสำหรับ API แต่ละตัวที่คุณต้องการใช้
ขั้นตอนในการตั้งค่า URL โทรกลับ:
- ไปที่ส่วน 'การกำหนดค่า'
- ไปที่แท็บ 'URL โทรกลับ'
- ป้อน URL ติดต่อกลับที่เกี่ยวข้องสำหรับบริการ API แต่ละรายการที่คุณวางแผนจะผสานรวม
- ใช้ Test URL หรือ Save & Test เพื่อยืนยันว่า Brick สามารถส่งคำขอโทรกลับและรับการตอบกลับที่คาดหวังจากเซิร์ฟเวอร์ของคุณ
ตารางการกำหนดค่า URL โทรกลับ
| บริการ API | ชื่อฟิลด์ URL โทรกลับ |
|---|---|
| การเบิกจ่าย APIs | URL โทรกลับการเบิกจ่าย |
| บัญชีเสมือน APIs | URL โทรกลับบัญชีเสมือน |
| QRIS APIs | URL โทรกลับ QRIS |
| กระเป๋าเงินอิเล็กทรอนิกส์ APIs | URL โทรกลับกระเป๋าเงินอิเล็กทรอนิกส์ |
หมายเหตุ: บริการ API แต่ละรายการต้องมี URL โทรกลับที่แตกต่างกัน ตรวจสอบให้แน่ใจว่าตำแหน่งข้อมูลที่คุณระบุได้รับการกำหนดค่าอย่างถูกต้องเพื่อจัดการกับคำขอ POST ขาเข้าจากเซิร์ฟเวอร์ของ Brick และส่งคืนการตอบสนองที่คาดไว้
การตอบสนองที่คาดหวังจากผู้รับการติดต่อกลับของคุณ
สำหรับการเรียกกลับธุรกรรมตามปกติ ให้ส่งคืน HTTP 200 หลังจากที่ระบบของคุณยอมรับและจัดเก็บเหตุการณ์การเรียกกลับแล้วเท่านั้น หากผู้รับของคุณส่งคืนการตอบกลับที่ไม่ใช่ 200 หมดเวลา หรือไม่สามารถเข้าถึงได้ Brick อาจถือว่าการโทรกลับล้มเหลว และลองอีกครั้งตามนโยบายการลองโทรกลับอีกครั้ง
เมื่อคุณทดสอบหรือบันทึก URL การติดต่อกลับจากแดชบอร์ด Brick จะส่งการโทรกลับเพื่อยืนยันความถูกต้องก่อน การทดสอบแดชบอร์ดจะสำเร็จก็ต่อเมื่อผู้รับของคุณส่งคืน HTTP 200 พร้อมด้วย JSON ACK ที่สะท้อนการทดสอบ referenceId ที่ส่งโดย Brick:
Code
คุณยังสามารถคืนค่าเดียวกันกับ reference_id ได้อีกด้วย ค่าต้องตรงกับ referenceId ในเพย์โหลดการทดสอบการเรียกกลับหรือส่วนหัว X-Brick-Test-Reference HTTP 200 ที่มีเนื้อหาว่าง ข้อความธรรมดา JSON ที่ไม่ถูกต้อง ข้อมูลอ้างอิงที่ขาดหายไป หรือข้อมูลอ้างอิงอื่นจะถือเป็นการทดสอบการเรียกกลับที่ล้มเหลว
การตั้งค่าการติดต่อกลับและการดำเนินการส่งอีกครั้งยังคงใช้เส้นทางการเขียนแดชบอร์ดที่มีอยู่สำหรับความเข้ากันได้แบบย้อนหลัง การตรวจสอบสถานะการโทรกลับเป็นแบบอ่านอย่างเดียวและเปิดเผยผ่านแดชบอร์ด v3 อ่านเส้นทาง GET /v3/exp/dashboard/disbursement/callback/status เมื่อดูจากแดชบอร์ดไคลเอ็นต์
สภาพแวดล้อม API
Brick มีสภาพแวดล้อมสองแบบแยกกันเพื่อรองรับทั้งกรณีการใช้งานการพัฒนาและการใช้งานจริง
หากต้องการสร้างและจัดการข้อมูลประจำตัว API ของคุณสำหรับแต่ละสภาพแวดล้อม ให้เข้าสู่ระบบ Brick Dashboard ไปที่เมนู Configuration และเลือกแท็บ API Credentials
สภาพแวดล้อมที่มีอยู่
| สิ่งแวดล้อม | URL ฐาน | วัตถุประสงค์ |
|---|---|---|
| แซนด์บ็อกซ์ | https://sandbox.onebrick.io/v2 | ใช้สภาพแวดล้อมนี้สำหรับการทดสอบและพัฒนา มันจำลองพฤติกรรมสดโดยใช้ข้อมูลจำลอง |
| การผลิต | https://api.onebrick.io/v2 | ใช้สภาพแวดล้อมนี้สำหรับแอปพลิเคชันถ่ายทอดสดที่เชื่อมต่อกับสถาบันการเงินจริง |
🚧 หมายเหตุสำคัญ
- ข้อมูลประจำตัวจะแตกต่างกันไปในแต่ละสภาพแวดล้อม ตรวจสอบให้แน่ใจว่าคุณใช้ client_key และ client_secret ที่ถูกต้องสำหรับสภาพแวดล้อมที่คุณทำงานอยู่
- ธุรกรรมในสภาพแวดล้อม Sandbox จะไม่ส่งผลกระทบต่อบัญชีหรือสถาบันจริง
- ก่อนที่จะเปลี่ยนไปใช้เวอร์ชันที่ใช้งานจริง ตรวจสอบให้แน่ใจว่าการผสานรวมของคุณได้รับการทดสอบอย่างสมบูรณ์ใน Sandbox