REST API
PATCH/ api/ v1/ onboarding
Автосохранить шаг и частичное обновление ответов только в статусе draft.
| Поле | Значение |
|---|---|
| URL | PATCH |
| Доступ | Cookie кабинета · Mini App (TMA) |
| Scope для ключей | ключи не принимаются – только кабинет (403 CREDENTIAL_) |
| operationId | onboardingPatch |
Описание#
Автосохранить шаг и частичное обновление ответов только в статусе draft (после submit – 422 ). Неизвестные поля запрещены; null очищает допускающий null ответ. Анкета состоит из 13 шагов; текущая версия схемы 2.
Auth: сессия кабинета (cookie) / TMA bearer. Scope: не требуется.
Path: параметров нет.
Query: нет объявленных полей.
Body: application/, OnboardingPatchRequest. Все вложенные поля и варианты – по ссылке.
| Поле | Тип | Обязательно | Ограничения |
|---|---|---|---|
step | integer | да | ≥ 0; ≤ 12 |
answers | OnboardingDraftPatch | да | – |
Ответ · статус и структура
Ответ: 200 application/, Onboarding.
Краткая форма: {.
Пример JSON; значения демонстрационные.
{
"schemaVersion": 2,
"status": "draft",
"step": 5,
"answers": {
"role": "Основатель бизнеса",
"business": "Развиваю студию дизайна, в команде 5 человек",
"scenario": [
"Продажи и заявки",
"Документы и отчёты",
"Другое"
],
"scenarioOther": "Разбор входящих брифов",
"level": "Пользуюсь ChatGPT/Claude каждый день",
"aiTools": [
"ChatGPT",
"Claude",
"Другое"
],
"aiToolsOther": "Midjourney",
"about": ""
},
"completedAt": null
}Ошибки: 401 , 403 , 503 , 429 , 403 , 422 , 403 ; общие ошибки.
Лимиты: Отдельного throttle в коде нет.
Запрос · JSON
{
"step": 5,
"answers": {
"aiTools": [
"ChatGPT",
"Claude",
"Другое"
],
"aiToolsOther": "Midjourney",
"goal": null,
"about": ""
}
}Пример · curl
curl -sS -i -X PATCH https://aos.edgelab.space/api/v1/onboarding \
--cookie '__Host-aos_sess=SESSION_PLACEHOLDER' \
-H 'Origin: https://aos.edgelab.space' \
-H 'Content-Type: application/json' \
-d '{"step":5,"answers":{"aiTools":["ChatGPT","Claude","Другое"],"aiToolsOther":"Midjourney","goal":null,"about":""}}'Ответы по контракту#
Тело запроса: OnboardingPatchRequest.
| Статус | Тип | Схема | Описание |
|---|---|---|---|
| 200 | application/json | Onboarding | Успех |
| ошибка | application/json | ErrorBody | Ошибка; коды: UNAUTHENTICATED, NO_ENTITLEMENT, ENTITLEMENT_UNAVAILABLE, RATE_LIMITED, ORIGIN_REJECTED, VALIDATION_FAILED |
Машиночитаемый контракт: openapi.json, операция onboardingPatch.