Выдать доступ к курсу с вашего сайта

Самый частый сценарий: человек приходит с рекламы, оставляет номер в форме на вашем сайте и должен сразу получить доступ к курсу. Для этого есть один метод, которому нужен только ключ школы — вход самого ученика не требуется.

Метод

curl -X POST "https://api.1app.kz/api/enterprise/v2/lms/invites" \
  -H "X-API-Key: ent_ваш_ключ" \
  -H "Content-Type: application/json" \
  -d '{
    "courseId": "id-курса",
    "streamId": "id-потока",
    "phoneNumber": "77001234567"
  }'

Что передавать

• courseId — id курса, берётся из списка курсов. Обязательно.
• streamId — id потока внутри курса. Обязательно: именно поток определяет, по какому расписанию откроются уроки.
• phoneNumber — телефон ученика, в любом формате, система приведёт его к своему виду. Обязательно.
• customPassword — пароль для нового аккаунта. Не обязательно: если не передать, будет 123456, и ученику лучше сменить его при первом входе.
• name и surname — имя и фамилия ученика. Не обязательно, но передавайте, если они есть в вашей форме: иначе ученик появится в вашей базе безымянным.

Что вернётся

• enrollmentId — запись ученика на курс, она и даёт доступ.
• isNewUser — создавали ли аккаунт заново или человек уже был в школе.
• credentials — логин и пароль для нового ученика, покажите их ему на странице «спасибо».
• isPending — доступ ждёт первого входа ученика.

Порядок на вашей стороне

1. 1
   Форма собирает номер телефона

   И отправляет его на ваш сервер, а не напрямую в 1Study: ключ должен остаться у вас.
2. 2
   Ваш сервер вызывает метод выше

   С ключом школы, id курса и id потока, заранее сохранёнными в настройках.
3. 3
   Показываете человеку, что дальше

   Ссылку на приложение и напоминание войти по тому же номеру, который он ввёл в форме.