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» — ачкычны бер минутта булдырыгыз.

Бушлай сынап карау Тарифлар