REST API
PUT/ api/ v1/ progress
Сохранить прогресс одного урока: хотя бы одно из positionSec, completed, homework.
| Поле | Значение |
|---|---|
| URL | PUT |
| Доступ | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth |
| Scope для ключей | progress: |
| operationId | progressPut |
Описание#
Сохранить прогресс одного урока: хотя бы одно из positionSec, completed, homework. completed: ставит отметку и сохраняет первую дату завершения при повторе; false и отсутствие поля сохраняют отметку. Завершение монотонно. Для закрытого урока нужна анкета. positionSec сохраняется с округлением вниз через Math.: например, 312. → 312.
Auth: сессия кабинета (cookie) / TMA bearer / API-ключ или OAuth access token. Scope: progress: (для ключей).
Path: параметров нет.
Query: нет объявленных полей.
Body: application/, ProgressUpdateRequest. Все вложенные поля и варианты – по ссылке.
| Поле | Тип | Обязательно | Ограничения |
|---|---|---|---|
lessonId | LessonCode | да | – |
positionSec | number | нет | ≥ 0; ≤ 86400 |
completed | boolean | нет | true / false |
homework | { | нет | – |
Ответ · статус и структура
Ответ: 200 application/, Progress.
Краткая форма: {.
Пример JSON с целочисленной сохранённой позицией; значения демонстрационные.
{
"completed": [
"pre.1"
],
"positions": {
"1.1": 312
},
"homework": {
"pre.1": {
"text": "Создал папку проекта и README.",
"sent": true
}
},
"milestonesDone": []
}Ошибки: 401 , 403 , 503 , 429 , 403 , 422 , 404 , 403 , 403 , 403 ; общие ошибки.
Лимиты: Agent-key/OAuth: 60/min/key, 2000/UTC day/key, 3000/UTC day/student.
Запрос · JSON
{
"lessonId": "1.1",
"positionSec": 312.5
}Пример · curl
curl -sS -i -X PUT https://aos.edgelab.space/api/v1/progress \
-H 'Authorization: Bearer aos_live_...' \
-H 'Origin: https://aos.edgelab.space' \
-H 'Content-Type: application/json' \
-d '{"lessonId":"1.1","positionSec":312.5}'Ответы по контракту#
Тело запроса: ProgressUpdateRequest.
| Статус | Тип | Схема | Описание |
|---|---|---|---|
| 200 | application/json | Progress | Успех |
| ошибка | application/json | ErrorBody | Ошибка; коды: UNAUTHENTICATED, NO_ENTITLEMENT, ENTITLEMENT_UNAVAILABLE, RATE_LIMITED, ORIGIN_REJECTED, VALIDATION_FAILED, NOT_FOUND, ONBOARDING_REQUIRED |
Машиночитаемый контракт: openapi.json, операция progressPut.