Робота з API

Головна/Технічні вимоги/Робота з API/Робота з API

Зміст

API
Пагінація

LMS Collaborator - це LMS система, яка працює на основі технології RESTful API.

API

API (англ. application programming interface, програмний інтерфейс програми) - набір готових класів, процедур, функцій, структур або констант, що надаються Collaborator для взаємодії з іншими програмами.
Використовується програмістами під час написання різноманітних додатків.

Ви можете використовувати наш API для експорту/імпорту інформації в Collaborator, інших команд, а також створення інтеграцій із зовнішніми програмами.

Довідник API Collaborator RESTful доступний за адресою https://your-domain-address/api/v2/doc/, там є весь список можливих запитів та їх опис.

Замість локальної адреси https://your-domain-address потрібно використовувати адресу вашого сервера.

Пагінація

API використовує пагінацію для розбиття великих наборів даних на менші частини. Кожен GET запит який повертає список даних має об'єкт з двома полями: data та pager. Поле pager містить інформацію про сторінки:

{
  "data": [], // Масив з даними
  "pager": {
    "current": 1,    // Поточна сторінка
    "count": 3,      // Кількість сторінок
    "total": 22,     // Загальна кількість записів
    "countPerPage": 10 // Кількість записів на сторінці
  }
}

Для навігації між сторінками використовуйте параметр page в запиті, приклад:

GET /api/v2/users/list?page=2&count=10