Перейти до змісту

API

REST API може бути потужним інструментом для керування вашим обладнанням та користувачами. Інтегруючи цей API у вашу систему (наприклад, білінгову систему), ви можете покращити додатковий функціонал для вашої системи. Додатково, ви також можете використовувати цей API для запитування інформації про ваше обладнання та управління пристроями.

Аутентифікація

Методи підтримки доступу:

  1. Використання автентифікаційного токена
  2. Використання довірених мереж

Використання автентифікаційного токена

1. Створіть користувача (наприклад, з логіном api_user, наприклад)
2. За допомогою консольної утиліти створіть автентифікаційний токен за допомогою наступної команди

wca user:generate-key api_user 365d     
де аргументи api_user - логін користувача, а 365d - термін дії ключа.
Відповідь повинна бути у вигляді таблиці, з одним полем, що містить ключ.
3. Тепер ви можете працювати з API, додавши заголовок X-Auth-Key: API_KEY_FROM_TABLE

Використання надійних мереж (не рекомендується)

На веб-панелі перейдіть до Конфігурація->Конфігурація системи->Конфігурація [вкладка].
У блоку безпеки встановіть поле списку довірених мереж у CIDR (наприклад, 10.0.0.0/8).

Запити без ключа, але з довіреної мережі відобразяться від вбудованого користувача sys

Документація

Методи API, приклади відповідей задокументовано в postman wildcoreAPI (Документація може не містити всю необхідну вам інформацію)

Також, оскільки веб-панель побудована на основі SPA-фреймворка, ви можете переглядати викликані методи API (через F12) і використовувати їх

Розробка

Для PHP-розробників додано SDK (тестування) - github.com/meklis/wildcore-api-client, приклади