การสมัครขอรับ API Key ในการเรียกใช้งาน API้
ตามนโยบายการใช้งาน API ผู้ใช้จะต้องลงทะเบียนเพื่อขอใช้บริการ API ก่อน จึงจะได้รับ API Key ของตนเอง เพื่อใช้ในการเข้าถึง API ของชุดข้อมูลได้ ทั้งนี้นโยบายดังกล่าวกำหนดขึ้นเพื่อป้องกันการเรียกใช้ API อย่างไม่ถูกต้อง เช่น การ attack server หรือ การเรียกใช้ API ในปริมาณที่มากเกินไป ซึ่งจะมีผลต่อประสิทธิภาพโดยรวมของระบบ นอกจากนี้ผู้ดูแลระบบยังต้องการทราบ profile พื้นฐานของนักพัฒนา เพื่อให้สามารถนำมาใช้ในการปรับปรุงบริการให้ตรงกับความต้องการของผู้ใช้แต่ละกลุ่มมากยิ่งขึ้นในอนาคต
ขั้นตอนการลงทะเบียนขอใช้บริการ API มีดังนี้
- จากเมนูของเว็บไซต์ http://api.bigdata.mol.go.th คลิกที่ลิงก์ "ลงทะเบียนรับข้อมูล"
- กรอกข้อมูลส่วนตัว และตั้งชื่อผู้ใช้และรหัสผ่าน และคลิกที่ปุ่ม "ลงทะเบียน"
- เมื่อผู้ดูแลระบบยืนยันตัวตนแล้ว ก็จะสามารถ Login เข้าสู่ระบบได้
ขั้นตอนการยืนยันตัวตนเพื่อดูข้อมูล API Key มีดังนี้
- ทำการเข้าสู่ระบบเว็บ API
- คลิกที่ลิงก์ "ดูข้อมูล" ด้านบนมุมขวา
- ท่านจะเห็น API key ของท่าน ในส่วนของ "Token Key" ดังรูป ซึ่ง User Token ดังกล่าว สามารถใช้ในการเข้าถึง Data API ทั้งหมดบนเว็บ
-
เพื่อความปลอดภัยและการรักษาความลับของ API Key ของท่านไม่ให้ผู้อื่นนำไปใช้ จึงควรระบุ API Key ลงในส่วนของ HTTP Header โดยใช้ method แบบ GET หรือ POST ในตัวอย่างนี้จะใช้โปรแกรม Postman (https://www.getpostman.com/downloads/) ในการสาธิตการเข้าถึง API โดยการระบุ parameter ชื่อ api-key และระบุค่า API Key ของผู้ใช้แต่ละคนในส่วน value
-
เมื่อดำเนินการเรียกข้อมูลผ่าน API ท่านจะได้ข้อมูลกลับมาในรูปแบบของ JSON