Загальні примітки

примітки до публічної документації
Написано Bimp
Оновлено 1 день тому
  1. Аутентифікація: Більшість роутів вимагають company access token в заголовку Authorization: Bearer <token>. Отримати токен можна через /auth/api-selectCompany.

  2. Формат дат: Всі дати передаються в форматі ISO 8601 з UTC timezone (закінчуються на 'Z'), наприклад: 2025-05-16T09:17:49.000Z.

  3. UUID: Всі ідентифікатори передаються як UUID (формат: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

  4. Пагінація:

    • Offset пагінація: використовується offset та count
    • Cursor пагінація: використовується limit та lastId (для великих наборів даних)
  5. Опціональні поля: Поля, позначені як ?, є опціональними і можуть бути відсутніми в запиті.

  6. Фільтри: Більшість readList ендпоінтів підтримують опціональні фільтри для уточнення результатів.

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