REST API
GET/ api/ v1/ onboarding
Прочитать текущую анкету, шаг, выбранный сетап и статус.
| Поле | Значение |
|---|---|
| URL | GET |
| Доступ | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth |
| Scope для ключей | profile: |
| operationId | onboardingGet |
Описание#
Прочитать текущую анкету, шаг, выбранный сетап и статус; данные принадлежат только вызывающему студенту.
Auth: сессия кабинета (cookie) / TMA bearer / API-ключ или OAuth access token. Scope: profile: (для ключей).
Path: параметров нет.
Query: нет объявленных полей.
Body: не требуется.
Ответ · статус и структура
Ответ: 200 application/, Onboarding.
Краткая форма: {.
Пример JSON; значения демонстрационные.
{
"schemaVersion": 2,
"status": "draft",
"step": 3,
"answers": {
"role": "Основатель бизнеса",
"business": "Развиваю студию дизайна, в команде 5 человек",
"scenario": [
"Продажи и заявки",
"Документы и отчёты",
"Другое"
],
"scenarioOther": "Разбор входящих брифов"
},
"completedAt": null
}Ошибки: 401 , 403 , 503 , 429 , 403 , 403 ; общие ошибки.
Лимиты: Agent-key/OAuth: 60/min/key, 2000/UTC day/key, 3000/UTC day/student.
curl -sS -i https://aos.edgelab.space/api/v1/onboarding \
-H 'Authorization: Bearer aos_live_...'Ответы по контракту#
| Статус | Тип | Схема | Описание |
|---|---|---|---|
| 200 | application/json | Onboarding | Успех |
| ошибка | application/json | ErrorBody | Ошибка; коды: UNAUTHENTICATED, NO_ENTITLEMENT, ENTITLEMENT_UNAVAILABLE, RATE_LIMITED |
Машиночитаемый контракт: openapi.json, операция onboardingGet.