Skillspace
  • Введение
  • API
    • Работа с учеником
  • Webhooks
    • Список событий
Powered by GitBook
On this page
  • Приглашение ученика
  • Пригласить ученика на курс (POST & GET)
  • Обновление кастомных полей ученика
  • Обновление кастомных полей ученика (POST & GET)
  • Удаление ученика с курса
  • Удаление ученика с курса (POST & GET)

Was this helpful?

  1. API

Работа с учеником

В запросах используется параметр courses, который является php-массивом и передается в GET следующим набором данных: &courses[ID_КУРСА]=ID_ГРУППЫ

Курсов может быть указано несколько таким способом, а ID_ГРУППЫ может быть пустым, тогда система автоматически определит группу ученика в соответствии с настройками курса.

Приглашение ученика

Пригласить ученика на курс (POST & GET)

GET https://skillspace.ru/api/open/v1/course/student-invite

Создать ссылку на нужный курс и группу можно в личном кабинете в настройках школы

Query Parameters

Name
Type
Description

token*

String

API ключ из настроек школы

name

String

Имя ученика

comment

String

Комментарий к ученику

courses*

Array[]

Список курсов и групп, подробнее расписано выше

email*

String

Email ученика

fields

Array[]

Список кастомных полей ученика со значениями

Обновление кастомных полей ученика

Обновление кастомных полей ученика (POST & GET)

GET https://skillspace.ru/api/open/v1/course/:id/student-update

Создать ссылку на для обновления нужных полей можно в личном кабинете в настройках школы

Query Parameters

Name
Type
Description

token

API ключ из настроек школы

email

Email студента которого необходимо удалить из курса

fields

Array[]

PHP Массив, аналогичный полю courses. Ключ - id поля, значение - новое значение поля

name

String

Обновленное имя

comment

String

Обновленный комментарий

Удаление ученика с курса

Удаление ученика с курса (POST & GET)

GET https://skillspace.ru/api/open/v1/course/:id/student-remove

Создать ссылку на нужный курс и группу можно в личном кабинете в настройках школы

Path Parameters

Name
Type
Description

Number

ID курса

Query Parameters

Name
Type
Description

token

API ключ из настроек школы

email

Email студента которого необходимо удалить из курса

PreviousВведениеNextСписок событий

Last updated 1 year ago

Was this helpful?