Open API

Тек оқуға арналған REST API. 1С, BI-дашборд, мектептің өз сайтын немесе скриптіңізді қосыңыз — ол мектебіңіздің деректерін қорғалған кілт бойынша оқиды. API арқылы ештеңе жазуға болмайды. Егер әзірлеуші кодта қателессе, Drivli-дегі оқушылар не төлемдер бұдан бұзылмайды.

«Профи» мен «VIP» тарифтерінде қолжетімді. Free мен «Стандарт»-та кілт берілмейді.

Авторизация

Кілтті директор кабинетінен алыңыз: Реквизиттер → 🔑 API → Кілт жасау. Оны әрбір сұраныстың тақырыбында жіберіңіз:

Authorization: Bearer drivli_pk_<32 hex>

Кілт дәл бір рет көрсетіледі — жасаған кезде көшіріп алыңыз.
Бір кілт = бір мектеп, бөгде деректер физикалық тұрғыдан қолжетімсіз.
Мектепке 10 белсенді кілтке дейін. Қолданылмайтындарын кері қайтарыңыз.
ДҚ-да тек кілттің хэші сақталады — ДҚ-ның бұзылуы жұмыс істейтін кілттерді бермейді.

Лимиттер

Профи: минутына 60 сұраныс.
VIP: минутына 600 сұраныс.
Асып кету → Retry-After: 60 тақырыбы бар 429 Too Many Requests жауабы.

Жылдам бастау

Алғашқы 10 белсенді оқушының тізімі:

curl -H "Authorization: Bearer drivli_pk_..." \
  "https://api.drivli.ru/api/public/v1/students?status=learning_practice&limit=10"

Жауап:

{
  "items": [
    {
      "id": "9b8a...",
      "full_name": "Иванов И. И.",
      "phone": "+7 555 ...",
      "email": "ivanov@example.com",
      "category": "B",
      "status": "learning_practice",
      "group_id": "f3c1...",
      "branch_id": null,
      "created_at": "2026-04-12T08:30:00Z"
    }
  ],
  "meta": { "total": 142, "limit": 10, "offset": 0 }
}

Эндпоинттер

Әдіс	Жол	Сипаттама
GET	/api/public/v1/students	Мектеп оқушыларының тізімі. Параметрлер: status, category, group_id, limit (≤200), offset
GET	/api/public/v1/students/{id}	Бір оқушының картасы.
GET	/api/public/v1/instructors	Нұсқаушылардың тізімі. Параметрлер: is_active, limit, offset
GET	/api/public/v1/vehicles	ОСАГО мен ТО күндері бар оқу автомобильдерінің тізімі. Параметрлер: limit, offset
GET	/api/public/v1/lessons	Кезең ішіндегі сабақтардың тізімі. Параметрлер: period_from, period_to, instructor_id, student_id, limit, offset
GET	/api/public/v1/contracts	Оқушылармен жасалған шарттар. Параметрлер: student_id, limit, offset
GET	/api/public/v1/payments	Кезең ішіндегі төлемдер. Параметрлер: period_from, period_to, limit, offset
GET	/api/public/v1/leads	Оқуға өтінімдер. Параметрлер: status, period_from, period_to, limit, offset
GET	/api/public/v1/reports/finance-summary	Кезең ішіндегі қаржылық жиынтық: кіріс, шығыс, пайда. Параметрлер: period_from, period_to

Қауіпсіздік

152-ФЗ бізден оқушылардың деректерін қорғауды талап етеді. Сондықтан API былай құрылған:

Тек HTTPS. HTTP бойынша мүлдем жауап бермейміз.
Тек GET. API арқылы бірдеңе жазуға немесе жоюға болмайды.
ДҚ-да бізде тек кілттің хэші жатады. Біреу біздің базаны алып кетсе — одан жұмыс істейтін кілттерді ала алмайды.
Бір кілт = бір мектеп. Қанша қаласа да кілт бөгде деректерді көрмейді — оқшаулау SQL-схема деңгейінде.
Әрбір сұраныс кілттің картасында белгіленеді: соңғы қолданылған күні мен есептегіш көрінеді. Кілтті біреу ұстап алса — бұл байқалады.
Кілтті кері қайтардыңыз — онымен жасалған келесі сұраныс 401 қайтарады. Репликацияға не кэшке кідіріссіз.

Жауап кодтары

200 — сәтті.
400 — сұраныс параметрі дұрыс емес.
401 — кілт жоқ, кілт қате немесе кілт кері қайтарылған.
402 — мектеп «Профи»-ден төмен тарифте, Open API жабық.
404 — сұралған нысан табылмады.
429 — минутына сұраныс лимиті асып кетті.
503 — rate-limit қызметі қолжетімсіз (сирек).

Қосылуға дайынсыз ба?

Директор кабинетін ашыңыз → «Реквизиттер» → «🔑 API» — кілтті бір минутта жасаңыз.

Тегін қолданып көру Тарифтер