Antcas API
Antcas API ช่วยให้สามารถแลกเปลี่ยนข้อมูลระหว่างแอปพลิเคชันหลายตัวได้。
| คำเตือน: ตรวจสอบความปลอดภัยเมื่อใช้ API นี้ คุณควรใช้ TLS เท่านั้น และไม่ต้องเปิดพอร์ตนี้บนที่อยู่ที่สามารถเข้าถึงได้จากสาธารณะ |
หมายเหตุ: เนื่องจาก API ต้องตรวจสอบโทเค็นทุกครั้งที่มีการเรียกใช้ จึงอาจทำให้ระบบมีภาระงานสูงขึ้น
ตั้งค่าพอร์ต API
ใน การจัดการโครงการ คุณสามารถเพิ่มพอร์ต API ใหม่ได้
การอธิบายนี้คุณจะพบในบทความ กำหนดพอร์ตให้กับโครงการ.
เพื่อให้สามารถสร้างคำขอได้ คำขอต้องถูกตรวจสอบด้วย โทเค็น การสร้างโทเค็นจะได้รับการอธิบายในบทความ จัดการโทเค็น.
รูปแบบและค่าที่ใช้
API นี้สนับสนุนหลายรูปแบบของข้อมูลที่รับ: HTTP-Queries, JSON และ XML ข้อมูลที่ส่งออกสามารถเป็น HTML, Text, JSON หรือ XML ได้ การเข้ารหัสตัวอักษรจะใช้ UTF-8
หมายเหตุ: การเรียกใช้โดยองค์ประกอบในเบราว์เซอร์จะทำให้เกิดข้อผิดพลาด 428 (Precondition Required) นี่คือการป้องกัน XSS Attack ซึ่งไม่สามารถเลี่ยงได้ การป้องกันนี้ช่วยป้องกันการโจมตี Antcas Control
เมื่อมีการส่งคำขอ POST หรือ PUT คุณสามารถเขียนข้อมูลในรูปแบบที่ถูกต้องผ่าน Content ได้ ตัวแปรทั้งหมดเป็น Case Sensitive ซึ่งหมายความว่าต้องแยกความแตกต่างระหว่างตัวพิมพ์ใหญ่และตัวพิมพ์เล็ก การส่งกลับจะใช้รูปแบบที่ถูกประกาศไว้ รูปแบบการออกข้อมูลสามารถระบุได้ผ่าน Header หรือผ่านตัวแปร format รูปแบบการรับข้อมูลจะถูกตรวจจับโดยอัตโนมัติ
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
รูปแบบต่อไปนี้ถูกสนับสนุนใน Header และตัวแปร format:
| Content-Type | Variable | Format |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | Text |
| text/csv | csv | CSV* |
| (อื่นๆ) | html | HTML |
*สนับสนุนเฉพาะรูปแบบการออกข้อมูลเท่านั้น
หมายเหตุ: รูปแบบ Text และ CSV มี UTF-8 BOM คุณสามารถปิดใช้งานได้โดยใช้ตัวแปร bom=FALSE
ถ้าค่าถูกระบุในหลายรูปแบบ รูปแบบที่สุดท้ายจะมีความสำคัญมากกว่า:
- HTTP-Header (เฉพาะรูปแบบการออกข้อมูลผ่าน Content-Type)
- GET
- POST
- JSON/XML (เป็น POST หรือ PUT Content)
ตัวแปรที่ใช้รับข้อมูล
ตัวแปรต่อไปนี้ถูกกำหนดทั่วไป:
| Variable | คำอธิบาย |
|---|---|
| format | รูปแบบของข้อมูลที่ออก |
| bom | BOM ในรูปแบบ UTF-8 ค่าเริ่มต้นคือ TRUE |
| key | อ่านตัวแปรเดียวที่ถูกประกาศไว้ วิธีนี้ไม่มีประสิทธิภาพเนื่องจากข้อมูลทั้งหมดต้องถูกเตรียมและกรองหลังจากนั้น คุณควรใช้วิธีนี้เฉพาะกับข้อมูลจำนวนน้อย |
| header | แสดง Header ค่าเริ่มต้นคือ TRUE |
| compact | รวมองค์ประกอบย่อยทั้งหมดเข้าด้วยกัน ถ้าไม่มีการระบุค่าบูลีน ค่านี้จะถูกใช้เพื่อรวมตัวแปรเข้าด้วยกัน ในกรณีอื่นๆ ค่าที่ใช้จะเป็น . |
| values | แสดงเฉพาะค่าและไม่แสดงชื่อตัวแปร ตัวเลือกนี้มีให้ใช้ได้เฉพาะกับ HTML, CSV และ Text |
| minimal | อะลิอัสสำหรับ header=FALSE, compact=minimal และ values=TRUE |
| csvdel | CSV-Delimiter ค่าเริ่มต้นคือ ; |
| csvenc | CSV-Enclosure-Klammern ค่าเริ่มต้นคือ " |
| csvesc | CSV-Escape-Zeichen ค่าเริ่มต้นคือ \ |
ตัวแปรต่อไปนี้สามารถใช้ทั่วไปได้ทั้งในการใช้งานทั่วไปและสำหรับตัวแปรเดี่ยวๆ เพื่อเรียกใช้ตัวแปรเดี่ยว คุณต้องระบุมันดังนี้:
time*:hr=true
ตัวอย่างข้างต้นเรียกใช้ตัวแปรทั้งหมดที่เริ่มด้วย time และ time itself ทุกกฎจะถูกตรวจสอบตามลำดับ ดังนั้นกฎที่เหมาะสมสุดท้ายจะมีความสำคัญมากที่สุด การค้นหาจะทำโดยการใช้ Regular Expression
| Variable | คำอธิบาย |
|---|---|
| hr | Human Readable ตัวแปรจะถูกแปลงเป็นข้อมูลที่สามารถอ่านได้โดยมนุษย์ ถ้ามีความเป็นไปได้ ค่าเริ่มต้นคือ TRUE สำหรับรูปแบบ HTML, CSV และ Text |
| numdec | จำนวนหลักที่อยู่หลังจุดทศนิยม |
| numths | ตัวคั่นพัน |
| numdot | จุดทศนิยม |
| prefix | เพิ่มข้อความก่อนตัวแปร |
| suffix | เพิ่มข้อความหลังตัวแปร |
เส้นทาง
ในบทความต่อไปนี้จะระบุการใช้งานของ API ทั้งหมด