Antcas API
Antcas API дозволяє обмінюватися даними між кількома програмами.
| ПОПЕРЕДЖЕННЯ: Зверніть увагу на безпеку при використанні цього API. Використовуйте лише TLS і ніколи не використовуйте порт на публічній адресі. |
Примітка: Оскільки API має перевіряти токен при кожному виклику, це може призвести до збільшення навантаження на систему.
Налаштування порту API
У розділі Керування проектом можна додати новий
порт API. Опис знаходиться в розділі Призначення порту проекту.
Щоб створити запит, його потрібно аутентифікувати за допомогою токена. Створення токена детальніше роз'яснюється в розділі Керування токенами.
Формати та значення
API підтримує кілька форматів введення: HTTP-запити, 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-заголовок (тільки формат виводу через Content-Type)
- GET
- POST
- JSON/XML (як вміст POST або PUT)
Змінні введення
Наступні змінні визначені глобально.
| Змінна | Опис |
|---|---|
| format | Формат виводу. |
| bom | BOM у форматі UTF-8. За замовчуванням TRUE. |
| key | Читає лише одну змінну, яка була оголошена. Цей метод неефективний, оскільки всі дані підготовлені і тільки потім фільтруються. Він повинен використовуватися лише для малих обсягів даних. |
| header | Вивести заголовок. За замовчуванням TRUE. |
| compact | Об'єднує всі піделементи в собі. Якщо не оголошено булеве значення, то цей значення використовується для об'єднання змінних. В іншому випадку використовується значення .. |
| values | Повертає лише значення, а не імена змінних. Ця опція доступна лише для HTML, CSV та тексту. |
| minimal | Аліас для header=FALSE, compact=minimal та values=TRUE. |
| csvdel | CSV-роздільник. За замовчуванням ; |
| csvenc | CSV-закривальні дужки. За замовчуванням " |
| csvesc | CSV-символ екранування. За замовчуванням \ |
Наступні змінні можуть використовуватися глобально, а також для окремих змінних. Щоб звернутися до однієї змінної, вона визначається наступним чином:
time*:hr=true
Наведений вище приклад звертається до всіх змінних, що починаються з time та саму time. Перевіряються всі правила послідовно. Таким чином, останнє відповідне правило має пріоритет. Пошук відбувається за допомогою регулярного виразу.
| Змінна | Опис |
|---|---|
| hr | Читабельно для людини. Змінні, якщо це можливо, перетворюються на дані, зрозумілі людині. За замовчуванням TRUE для формату HTML, CSV та тексту. |
| numdec | Кількість знаків після коми. |
| numths | Роздільник тисяч. |
| numdot | Десятковий роздільник. |
| prefix | Додати текст перед змінною. |
| suffix | Додати текст після змінної. |
Шляхи
У наступних розділах визначені всі застосування API.