BOT API Overview

1. การสมัครเปิดบัญชี (Create Account)

Developer Portal
No.	URL
1	https://portal.api.bot.or.th

ตารางประกอบที่ 1 : URL สำหรับเข้าหน้า Developer Portal เพื่อสมัครเปิดบัญชี

1.1 เข้าหน้า Developer Portal ตาม URL ตารางประกอบที่ 1 ด้านบน และกดปุ่ม “Log in”

ภาพประกอบที่ 1 : หน้า Portal สำหรับ Create User

1.2 เลือกปุ่ม “Sign up Now”

ภาพประกอบที่ 2 : หน้า Portal สำหรับ Create User (Sign Up)

1.3 กรอกข้อมูล Email โดยจะได้รับ Verification Code ผ่านทางอีเมล์และนำมายืนยันตัวตน และกรอกข้อมูลอื่นๆ

• New Password/รหัสผ่าน

• Confirm New Password/ยืนยันรหัสผ่าน

• Captcha/กรอกตัวอักษรที่เห็นบนหน้าจอ

• Given name/ชื่อ

• Surname/ นามสกุล

หลังจากนั้นกด “Create” เพื่อดำเนินการสร้าง Account ในระบบ

ภาพประกอบที่ 3 : หน้า Portal สำหรับ Create User (หน้ากรอกข้อมูลสำหรับสมัคร Account)

1.4 หลังจากดำเนินการสร้าง Account แล้วนั้นจะปรากฏ หน้าจอดังภาพประกอบที่ 4 โดยมีชื่อ และ นามสกุลที่มุมบนขวา

ภาพประกอบที่ 4 : หน้า Portal หลังจากการสมัคร Account สำเร็จ

2. การสมัครใช้ API เพื่อใช้ยืนยันตัวตน

ภาพประกอบที่ 5 : หน้า Portal หลังจากการสมัคร Account สำเร็จ

2.1. เลือกเมนู “Catalogues”

2.2. เลือก Product Catalogues ที่ต้องการ Subscribe

ภาพประกอบที่ 6 : หน้า Catalogues สำหรับ เลือก Plan ในการ Subscribe

2.3. เลือก “Overview” Tab

2.4. เลือก Plan ที่สนใจ Subscribe “Access with this plan”

ภาพประกอบที่ 7 : หน้า Catalogues สำหรับหลังจากเลือก Plan

2.5. หลังจาก Subscribe “Access with this plan” จะปรากฏข้อความ “Success! This API Product was added to cart. Go to cart to complete the request.” เพื่อยืนยันว่าได้ Subscribe Product นี้เรียบร้อยแล้ว

2.6. หลังจากนั้นสังเกต มุมบนขวา จะมีรูปตะกร้าและแสดงเลขที่เรา Subscribe Product แต่ยังไม่ได้รับการ Approve โดยคลิกที่รูปตะกร้าเพื่อกรอกรายละเอียดชื่อ Application

2.7. หัวข้อ “Selected Products” เพื่อตรวจสอบ Product ที่เลือกมาถูกต้องตามข้อ 2.5 หรือไม่

2.8. หัวข้อ “Selected Plan” เพื่อตรวจสอบ Plan ในการส่งข้อมูลผ่าน API Gateway เป็นไปตามข้อ 2.5 หรือไม่

2.9. สร้าง Application โดยจะมี Option ให้เลือก ระหว่าง “Create a new app” และ “Existing App”

1) “Create a new app” คือการสร้าง Application ใหม่

2) “Existing App” คือการสร้าง Application ใหม่โดยใช้ชื่อ Application ก่อนหน้าแต่ Product แยกกันเป็นต้น

2.10. กรอกชื่อ “App Name”

2.11. กรอกรายละเอียด ในกรอบของ “Description”

2.12. เมื่อกรอกครบถ้วนกด Submit Request

3. การใช้งาน Application

ภาพประกอบที่ 8 : หน้ารายละเอียดของ Application ต่างๆที่สร้างไว้

3.1. ไปที่มุมบนขวา เลือก “Profile”

3.2. เลือก “My apps” ที่ด้านซ้ายมือ

3.3. เลือกชื่อ Application ที่สร้างไว้จากข้อ 2

ภาพประกอบที่ 9 : หน้ารายละเอียดของ Application และ Credential ของ Application

3.4. ตรวจสอบชื่อ Application Name

3.5. หลังจากระบบ Approved Access นั้น ผู้ใช้งานจะเห็น Token ที่ Hidden ไว้

3.6. เมื่อต้องการใช้งานให้กด ปุ่ม “Copy”

3.7. ตรวจสอบรายละเอียดของ Product เช่นมี Rate Limit เท่าไหร่ เป็นต้น

Header key	Header value
Authorization	Use the new token from new BOT API Portal

ภาพประกอบที่ 10 : ตัวอย่างการเรียก Application ผ่าน Postman

ตัวอย่างการเรียกใช้งานจาก Postman

3.8. กรอก Endpoint ของ Gateway และตามด้วย /listen_path/

3.9. กรอกรายละเอียดลงใน Application ในที่นี้ใช้ Header Key ชื่อ “Authorization”

3.10. เมื่อส่งข้อมูลสำเร็จจะได้ Response Code 200 OK ตามตัวอย่าง

4. วิธีการตรวจสอบการเรียกใช้งานของ Application

ภาพประกอบที่ 11 : ตัวอย่างการเรียก Analytic Log ผ่านหน้าจอ Dashboard

4.1. ไปที่มุมบนขวา เลือก “Profile” และเลือก “Dashboard” ที่ด้านซ้ายมือ

4.2. เลือก Tab “Performance” เพื่อดูภาพรวม

4.3. แสดงภาพรวมรายสัปดาห์ ขึ้นอยู่กับการเลือกการแสดงผลเป็นต้น

4.4. สามารถ Export to CSV ได้

4.5. แสดง “Top 5 highest error rates by API”

4.6. แสดง “Error breakdown”