Antcas API
Antcas API امکان تبادل داده بین چند برنامه را فراهم می کند.
| هشدار: هنگام استفاده از این API به امنیت دقت کنید. فقط TLS را استفاده کنید و این پورت را هرگز در یک آدرس عمومی قرار ندهید. |
توجه: زیرا API در هر بار فراخوانی باید توکن را بررسی کند، این ممکن است باعث افزایش بار سیستم شود.
تنظیم یک پورت API
در مدیریت پروژه می توانید یک
پورت API جدید اضافه کنید. توضیحات را در بخش پورت را به پروژه اختصاص دادن پیدا می کنید.
برای ایجاد یک درخواست، باید این درخواست با استفاده از توکن احراز هویت شود. ایجاد توکن در بخش مدیریت توکن به طور دقیق توضیح داده شده است.
فرمت ها و مقادیر
API چندین فرمت ورودی را پشتیبانی می کند: HTTP-Queries, JSON و XML. خروجی می تواند از HTML، متن، JSON یا XML باشد. کدگذاری کاراکتر همیشه UTF-8 است.
توجه: یک فراخوانی توسط یک عنصر در مرورگر باعث ایجاد خطای 428 (Precondition Required) می شود. این محافظت از حمله XSS است، که نمی توان آن را دور زدن. این مانع از حمله هکر به Antcas Control می شود.
در هنگام درخواست POST یا PUT، داده ها می توانند در محتویای مربوطه با فرمت مناسب نوشته شوند. هر متغیر حساس به حروف بزرگ و کوچک است، یعنی بین حروف بزرگ و کوچک تمایز وجود دارد. خروجی همیشه با فرمت اعلام شده انجام می شود. فرمت خروجی می تواند از طریق هدر یا متغیر format توصیف شود. فرمت ورودی همیشه خودکار تشخیص داده می شود.
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
فرمت های زیر در هدر و به عنوان متغیر format پشتیبانی می شوند:
| Content-Type | متغیر | فرمت |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | متن |
| text/csv | csv | CSV* |
| (دیگر) | html | HTML |
*فقط به عنوان فرمت خروجی پشتیبانی می شود.
توجه: فرمت های متن و CSV شامل UTF-8 BOM هستند. این می تواند با متغیر bom=FALSE غیر فعال شود.
اگر یک مقدار توسط چندین فرمت توصیف شود، فرمت آخر اولویت دارد:
- HTTP-Header (فقط فرمت خروجی از طریق Content-Type)
- GET
- POST
- JSON/XML (به عنوان POST یا PUT-Content)
متغیر های ورودی
متغیر های زیر به طور جهانی تعریف شده اند.
| متغیر | توضیحات |
|---|---|
| format | فرمت خروجی. |
| bom | BOM در فرمت UTF-8. پیش فرض TRUE است. |
| key | فقط یک متغیر را می خواند که اعلام شده است. این روش غیر کارآمد است، زیرا همه داده ها آماده شده اند و سپس فیلتر می شوند. باید فقط برای حجم های کوچک از داده ها استفاده شود. |
| header | هدر را نمایش دهید. پیش فرض TRUE است. |
| compact | همه زیر عناصر را در خود جمع می کند. اگر یک مقدار بولیان اعلام نشده باشد، این مقدار برای جمع آوری متغیر ها استفاده می شود. در غیر این صورت مقدار . استفاده می شود. |
| values | فقط مقادیر و نام های متغیر را برگرداند. این گزینه فقط برای HTML، CSV و متن در دسترس است. |
| minimal | نام جایگزین برای header=FALSE, compact=minimal و values=TRUE. |
| csvdel | CSV-Delimiter. پیش فرض ; است |
| csvenc | CSV-Enclosure-Klammern. پیش فرض " است |
| csvesc | CSV-Escape-Zeichen. پیش فرض \ است |
متغیر های زیر می توانند به طور جهانی، همچنین برای متغیر های فردی استفاده شوند. برای اشاره به یک متغیر فردی، این مانند زیر تعریف شده است:
time*:hr=true
مثال بالا همه متغیر ها را که با time شروع می شود و time خود را هدف قرار می دهد. همه قوانین به ترتیب بررسی می شوند. بنابراین آخرین قانون مناسب اولویت دارد. جستجو با استفاده از عبارت منظم انجام می شود.
| متغیر | توضیحات |
|---|---|
| hr | Human Readable. متغیر ها، اگر ممکن باشد، به داده های قابل خواندن توسط انسان تبدیل می شوند. پیش فرض TRUE برای فرمت HTML، CSV و متن است. |
| numdec | تعداد خانه های بعد از کاما. |
| numths | جایگزین هزارگان. |
| numdot | جایگزین اعشاری. |
| prefix | متن قبل از متغیر اضافه کنید. |
| suffix | متن بعد از متغیر اضافه کنید. |
مسیر ها
در بخش های زیر همه کاربردهای API تعریف شده اند.