API Instruction
CORPUS
API CORPUS API เป็นการให้บริการข้อมูลรูปแบบใหม่ผ่านเทคโนโลยี API (Application Programming Interface) ซึ่งเป็นเทคโนโลยีการเชื่อมต่อข้อมูลโดยอัตโนมัติจากระบบหนึ่งไปสู่ระบบอื่นๆ ได้อย่างรวดเร็ว และปลอดภัย
ผู้ใช้บริการสามารถท�ำการค้นหาข้อมูลบริษัทโดยใช้ “เลขทะเบียนนิติบุคคล” และ / หรือ “ชื่อบริษัท” ผ่านระบบของผู้ใช้บริการ เช่น ระบบงานด้านการขาย ระบบจัดซื้อ ระบบบัญชี ระบบ EPR หรือระบบ CRM ได้โดยตรง จากนั้นระบบของผู้ใช้บริการจะท�ำการส่ง ค�ำค้นหาดังกล่าวผ่านช่องทาง API เพือ่ มาสืบค้นในฐานข้อมูลของระบบ CORPUS และ ดึงข้อมูลกลับไปแสดงผลในระบบของผูใ้ ช้บริการ โดยอัตโนมัติ เพื่อช่วยอ�ำนวยความสะดวกในการท�ำงาน ลดระยะเวลาการสืบค้นข้อมูล ง่ายต่อการน�ำข้อมูลไปใช้ และลดความผิดพลาด ในการท�ำงาน ค่าบริการ CORPUS API จะคิดค่าบริการเป็นราย Transaction ตามชุดข้อมูลที่ผู้ใช้บริการเลือก และหักค่าบริการจากชั่วโมง การใช้งานคงเหลือตามสัญญา การค�ำนวณค่าบริการเพื่อตัดชั่วโมงใช้งาน ขึ้นอยู่กับราคาของแต่ละแพ็คเกจ 1 I
ขั้นตอนการใช้บริการ CORPUS API 1. สมัครใช้บริการ CORPUS เพื่อรับ Username และ Password (กรณีที่เป็นผู้ใช้ บริการ CORPUS แล้ว สามารถใช้ Username และ Password ที่มีอยู่เพื่อเข้าถึงการใช้งาน API Function ได้) 2. เลือกชุดข้อมูล (API Data Set) ที่ต้องการ 3. ปรับปรุง Database เพื่อรองรับข้อมูลที่จะ return กลับจาก CORPUS API 4. ก�ำหนดค่า API : ข้อมูลพื้นฐานของ API และข้อมูลพารามิเตอร์ส�ำหรับใช้งาน API 5. เริ่มใช้บริการ
I 2
ชุดข้อมูล (API Data Set)
Field Name
Type
Description
RegistrationNo
string
เลขทะเบียนนิติบุคคล
CompanyName
string
ชื่อบริษัท
CompanyStatus
string
สถานภาพกิจการ
Address
string
ที่อยู่
TelephoneNo
string
เบอร์โทรศัพท์
MeetingDate
string
วันประชุมผู้ถือหุ้น
Director
string
กรรมการ
No
string
ล�ำดับที่
Name
string
ชื่อกรรมการ
string
ผู้ถือหุ้น
No
string
ล�ำดับที่
Name
string
ชื่อผู้ถือหุ้น
Nationality
string
สัญชาติผู้ถือหุ้น
Percent Share
string
% ของการถือหุ้น
Shareholder (Top 10 รายแรก)
3 I
Field Name
Type
Description
NoShare
string
จ�ำนวนหุ้นที่ถือ
BahtShare
string
มูลค่าหุ้นที่ถือ (บาท)
RegistrationDate
string
วันที่จดทะเบียน
RegisteredCapital
string
ทุนจดทะเบียน
BusinessSize
string
ขนาดธุรกิจ (เล็ก, กลาง, ใหญ่)
CompanyType
string
ประเภทกิจการ
TSIC
string
ประเภทธุรกิจ
Code
string
รหัสธุรกิจ
Description
string
ค�ำบรรยายรหัสธุรกิจ
FSClass
string
FS Class
Code
string
ระดับความเสี่ยง
Description
string
ค�ำอธิบายระดับความเสี่ยง
LatestFSYear
string
ปีงบการเงิน (ล่าสุด)
TotalAssets
string
สินทรัพย์รวม
ShortTermLoansInLiabilities
string
รวมเงินกู้ยืมระยะสั้น
LongTermLoansInLiabilities
string
รวมเงินกู้ยืมระยะยาว
RetainedEarning
string
ก�ำไร (ขาดทุน) สะสม
TotalRevenue
string
รายได้รวม
GrossProfit
string
ก�ำไรขั้นต้น
IncomeBeforeDepreciation
string
ก�ำไรก่อนค่าเสื่อมและค่าตัดจ่าย
IncomeBeforeInterestAndIncomeTaxes
string
ก�ำไรก่อนดอกเบี้ยและภาษีเงินได้
NetIncome
string
ก�ำไร (ขาดทุน) สุทธิ
I 4
ขั้นตอนการเรียกใช้บริการ
CORPUS API ระบบของผู ใช บร�การ
1
ระบบของคอร พัส ส ง User Name และ Password เพ�่อขอ Token
ส ง Token กลับให ระบบของผู ใช บร�การ (Token มีอายุใช งานครั้งละ 1 ชั่วโมง) นำ Token ที่ได ใส ใน header
3
2
*ส ง Parameter เพ�่อ check available data ส งผลการ check available data กลับ
ส ง Parameter เพ�่อ request ข อมูล
4
ส งข อมูลตาม Set และเง�่อนไขที่กำหนดกลับให ผู ใช บร�การ
*หมายเหตุ: ขั้นตอนนี้เป นการตรวจสอบว ามีข อมูลนิติบุคคลที่ต องการบนระบบ CORPUS หร�อไม โดยต องเลือก API Set ที่ 7 เท านั้น เนื่องจาก นี้จะไม ารเก็บค าใช จ าย ซึ่งาผูมี ใขช ้อบร�มูกลารสามารถข ตอนนี้ได *หมายเหตุ : ขั้นSet ตอนนี ้เป็มนีกการตรวจสอบว่ นิติบุคคลทีามขั ่ต้อ้นงการบนระบบ CORPUS หรือไม่ โดยต้องเลือก API Set ที่ 7 เท่านั้น เนื่องจาก Set นี้จะไม่มีการเก็บค่าใช้จ่าย ซึ่งผู้ ใช้บริการสามารถข้ามขั้นตอนนี้ได้
5 I
การก�ำหนดค่า API 1. ก�ำหนดข้อมูลพื้นฐานของ API
2. ก�ำหนด API Path (URL ตามที่ก�ำหนด ส�ำหรับการ request ในขั้นตอนต่างๆ) 3. ก�ำหนดค่าพารามิเตอร์ส�ำหรับใช้งาน API (ผู้ใช้บริการจะต้องสร้าง Database เพื่อรองรับรายการข้อมูลตามชุดข้อมูลที่เลือกใช้บริการ)
ค่าพารามิเตอร์ที่ใช้ส�ำหรับการ Request 1. ขั้นตอนการขอ Token - Username : เป็น Username ของระบบ CORPUS ที่มีสิทธิในการใช้งาน API Function - Password : เป็น Password ของระบบ CORPUS ที่มีสิทธิในการใช้งาน API Function - URL : เป็น URL ที่ใช้ส�ำหรับการส่ง parameter เข้ามา request 2. ขั้นตอนการ check available data Parameter Name
Type
Description
Example Data
dataSetId
string
API Data Set
7
rgno
string
Registration No
0107000278860
companyName
string
Company Name
Sample Corporate Public Company Limited 278860
language
string
Language(Thai = TH, English = EN)
EN
3. ขั้นตอนการ request ข้อมูล Parameter Name
Type
Description
Example Data
dataSetId
string
API Data Set
7
rgno
string
Registration No
0107000278860
companyName
string
Company Name
Sample Corporate Public Company Limited 278860
language
string
Language(Thai = TH, English = EN)
EN
companyStatus
string
Company Status (All = 1, Active = 2 , InActive = 3)
2
I 6
FAQs 1. API คือ อะไร?
API หรือ Application Programming Interface เป็นบริการช่องทางการเชื่อมต่อเพื่อแลกเปลี่ยนข้อมูลจากระบบคอร์พัสไปสู่ ระบบอื่นๆ ที่ สะดวก รวดเร็ว ปลอดภัย หน้าที่หลักของ API คือคอยรับค�ำสั่งจากฝั่ง Client ซึ่งก็คือ Application ต่างๆ เช่น Web App., Mobile App., Desktop App. เป็นต้น เมื่อฝั่ง Client ส่งค�ำสั่ง จะเรียกว่าการ Request จากนั้น ตัว API จะรับค�ำสั่งดังกล่าว น�ำไป ประมวลผล และสรุปเป็นข้อมูลที่ตรงกับ Request และส่งข้อมูลเหล่านั้นกลับไปที่ฝั่ง Client หรือ Application เพื่อน�ำไปใช้งานต่อไป
2. วิธีการคิดค่าบริการ
วิธีการคิดค่าบริการ CORPUS API จะคิดค่าบริการเป็นราย Transaction ตามชุดข้อมูลที่ผู้ใช้บริการเลือก และหักค่าบริการ จากชั่วโมงการใช้งานคงเหลือตามสัญญา การค�ำนวณค่าบริการเพื่อตัดชั่วโมงใช้งาน ขึ้นอยู่กับราคาของแต่ละแพ็คเกจ
3. ข้อมูลที่สามารถใช้ในการค้นหาได้มีอะไรบ้าง?
ข้อมูลที่สามารถท�ำการค้นหา ได้แก่ 1) เลขทะเบียนนิติบุคคล 13 หลัก และ/หรือ 2) ชื่อบริษัท (ภาษาไทย) หรือชื่อบริษัท (ภาษาอังกฤษ) กรณีทผี่ ใู้ ช้บริการท�ำการค้นหาโดยใช้ทงั้ เลขทะเบียนนิตบิ คุ คล และชือ่ บริษทั ระบบจะท�ำการค้นหาโดยใช้เลขทะเบียนนิตบิ คุ คล ก่อน หากไม่เจอจึงจะท�ำการค้นหาโดยใช้ชื่อบริษัท โดยเลขทะเบียนนิติบุคคลและชื่อบริษัทนั้น จะท�ำการค้นหาแบบถูกต้องทั้งหมด (100% Match) อย่างเดียวเท่านั้น
4. ระบบจะส่งข้อมูลตามชุดข้อมูลที่เลือกครบทุกรายการใช่หรือไม่?
CORPUS API จะส่งข้อมูลตามชุดข้อมูลที่ผู้ใช้บริการเลือกครบทุกรายการ อย่างไรก็ตาม หากบริษัทที่ท�ำการค้นหาไม่มีข้อมูล บางรายการ ระบบจะส่งเป็น “ค่าว่าง” (NULL) และสงวนสิทธิคิดค่าบริการเต็มจ�ำนวนตามชุดข้อมูลที่เลือก
5. กรณีที่ไม่พบข้อมูลที่ทาการค้นหา ระบบจะแสดงผลอย่างไร?
CORPUS API จะส่งข้อความแจ้งกลับ ดังนี้ “ไม่พบข้อมูลนิติบุคคลที่ทาการค้นหา” หมายเหตุ: กรณีที่ต้องการให้ระบบของผู้ใช้บริการแสดงข้อความดังกล่าวในหน้าจอของผู้ใช้งาน ผู้ใช้บริการต้องการทาปรับปรุงระบบ เพื่อแสดงข้อความแจ้งเตือน
6. กรณีที่มีชั่วโมงการใช้งานคงเหลือไม่เพียงพอสาหรับการหักค่าบริการ ระบบจะแสดงผลอย่างไร?
CORPUS API จะส่งข้อความแจ้งกลับ ดังนี้ “จานวนชั่วโมงคงเหลือไม่เพียงพอ” หมายเหตุ: กรณีที่ต้องการให้ระบบของผู้ใช้บริการแสดงข้อความดังกล่าวในหน้าจอของผู้ใช้งาน ผู้ใช้บริการต้องการทาปรับปรุงระบบ เพื่อแสดงข้อความแจ้งเตือน
7 I
7. กรณีที่มีชั่วโมงการใช้งานคงเหลือไม่เพียงพอสาหรับการหักค่าบริการ ระบบจะแสดงผลอย่างไร?
CORPUS API จะส่งข้อความแจ้งกลับ ดังนี้ “จานวนชั่วโมงคงเหลือไม่เพียงพอ” หมายเหตุ: กรณีที่ต้องการให้ระบบของผู้ใช้บริการแสดงข้อความดังกล่าวในหน้าจอของผู้ใช้งาน ผู้ใช้บริการต้องการทาปรับปรุงระบบ เพื่อแสดงข้อความแจ้งเตือน
8. สามารถตรวจสอบชั่วโมงการใช้งานคงเหลือได้จากที่ใด?
ผูใ้ ช้บริการสามารถทาการตรวจสอบชัว่ โมงการใช้งานคงเหลือได้จากหน้าแรก (Home) ของระบบ Corpus ภายใต้ “ข้อมูลของท่าน”
9. Token มีระยะเวลาการใช้หรือไม่?
Token มีระยะเวลาการใช้งาน 1 ชั่วโมง เมื่อครบ 1 ชั่วโมง ระบบข้องผู้ใช้จะต้องส่ง request มาขอรับ Token ใหม่
10. หาก Token หมดอายุ จะมี message แจ้งหรือไม่?
หาก Token หมดอายุ แต่ยังมีการส่ง request เพื่อขอข้อมูลเข้ามา ระบบจะ return message : “Authorization has been denied for this request.” ระบบของผู้ใช้ จะต้องส่ง request ขอ Token เข้ามาใหม่ I 8
© 2019 BUSINESS ONLINE PCL. 1023 MS Siam Tower, 28th Floor, Rama 3 Road, Chong Nonsi, Yannawa, Bangkok 10120 Tel: 66(0) 2657 3999 ext. 2111-6 Fax: 66(0) 2657 3900 Email: corpus@bol.co.th www.BOL.co.th