Загальна інормація

У цьому розділі описано процес автентифікації та керування доступом до API системи за допомогою токенів JWT, які передаються в заголовку запиту під ключем access-token
Написано Bimp
Оновлено 1 місяць тому

Існує два типи токенів:

• Базовий токен доступу — використовується для запитів, не прив’язаних до конкретної компанії.

• Токен доступу, специфічний для компанії — використовується для запитів, пов’язаних з певною компанією.

Кроки використання
Крок 1 — Отримання базового токена доступу
Надішліть запит до /auth/api-login з електронною поштою та паролем користувача, зареєстрованого спеціально для використання API.
Отриманий токен можна використовувати для запитів, не прив’язаних до компанії (наприклад, /company/api-readDetailedList для отримання списку компаній).

Крок 2 — Отримання ідентифікатора компанії
Використовуючи базовий токен доступу, надішліть запит до /company/api-readDetailedList та знайдіть код або uuid потрібної компанії.

Крок 3 — Отримання токена доступу, специфічного для компанії
Передайте базовий токен доступу та код компанії в запиті до /auth/api-selectCompany.
У відповіді ви отримаєте companyAccessToken, який слід передати в заголовку запиту (access-token) для всіх операцій, пов’язаних з цією компанією (наприклад, /invoiceForCustomerPayment/api-readList).

Термін дії та поновлення токена

• Токен доступу (базовий або специфічний для компанії) дійсний протягом 1 години.

• Токен оновлення дійсний протягом 1 тижня.

Процес поновлення токена:

• Якщо термін дії токена доступу закінчився, надішліть запит до /auth/api-refresh, надавши дійсний токен оновлення.

• Якщо термін дії токена оновлення також закінчився, вам потрібно повторно автентифікуватися через /auth/api-login, щоб отримати новий набір токенів.

Чи була наша стаття корисною?