База знань LMS Collaborator

API token — це унікальний ідентифікатор, який використовується для автентифікації користувача для доступу до API. Він створюється на порталі і має бути доданий до кожного запиту API для авторизації доступу до захищених ресурсів.

Генерувати API token може користувач з правом Може створювати токен автентифікації API.

Згенерувати API token можна на сторінці Безпека:

По кліку на кнопку "Додати токен" з'являється модальне вікно створення токена, де потрібно спочатку вказати назву токена, термін його дії та роль, для якої він буде використовуватись, після чого застосувати його:

Токен створено, потрібно його скопіювати з модального вікна:

Або одразу після його закриття, але обов'язково до оновлення сторінки:

Після оновлення сторінки токен не можна буде скопіювати:

За 3 дні до закінчення терміну дії токену, система надішле лист про те, що потрібно оновити даний токен або створити новий:

Міграція механізму авторизації для API

Раніше для отримання API-токена потрібно було щоразу авторизуватись на порталі перед виконанням будь-якого API-запиту. З релізом версії 2.43 ми реалізували можливість створювати API-токени, які можна використовувати для виконання всіх запитів, замість авторизації по логіну і паролю. Для міграції вашого коду на новий спосіб потрібно:

1) Створити АРІ-токен (див. інструкцію вище)

2) Видалити у вашому коді частину логіки, яка відповідала за автентифікацію через мерз POST метод https://your-domain.com/api/rest.php/auth/session

3) Оновити всі АРІ запити у коді - замінити заголовок Authorization: Bearer XXXXX на X-Cbr-Authorization: Bearer YYYYY. Де XXXXX - це JWT-токен, який раніше отримувався після автентифікації, YYYYY - новий АРІ-токен.