Документация InSkill
  • О платформе
  • Мобильное приложение
  • 📋Общее
    • Как клиенты учитываются в тарифе
  • 💪Курсы
    • Каталог упражнений
    • Создание курса тренировок
    • Создание тренировки
  • 🥑Питание
    • Создание программы питания
    • Недели в программах питания
    • Автоматический подбор питания
  • 💼Продукты
    • Создание продукта
    • Подключение к своему сайту
    • Каталог тренеров
      • Приветственное видео
      • Результаты и отзывы
    • Заявки от клиентов
  • 💬Сообщения
    • Личные сообщения
    • Групповые чаты
  • 💵Платежи
    • Промокоды
  • ⚙️ Настройки проекта
    • Прием платежей
      • Robokassa
      • CloudPayments
      • Яндекс.Касса
      • Яндекс.Деньги
      • PayPal
    • Интеграции
      • Zoom
      • retailCRM
      • Webhook
    • API
      • Students
Powered by GitBook
On this page
  • Index
  • Show
  • Create
  • Update
  1. ⚙️ Настройки проекта
  2. API

Students

Методы для управления участниками проекта.

Index

GET https://{subdomain}.inskill.ru/api/v3/students

Поиск пользователей

Path Parameters

Name
Type
Description

subdomain*

String

Уникальный поддомен вашего проекта

Query Parameters

Name
Type
Description

search*

String

Строка для поиска пользователей. Поиск осуществляется по email, ФИО и номеру телефона.

withProducts

Boolean

Возвращать информацию о продуктах, или нет?

{
  // Основные данные ученика
  "data": {
    "id": 5,
    "name": "Ольга",
    "email": "user123@example.com",
    "phone": "+79123456789",
    "avatar": "https://path.to/image.jpg",
    "isActive": true // Есть ли у пользователя активный доступ к курсам? 
  },
  // Данные о продуктах ученика
  "products": [
    {
      "id": 133,
      "name": "Женщины. Дом. Новички.",
      "price": 2900.00,
      "currency": "RUB",
      "pivot": {
        "is_form_filled": 0, // Заполнена ли анкета
        "payment_id": null, // ID платежа, по которому был выдан продукт
        "is_delivered": false, // Продукт уже активирован, или нет?
        "created_at": "2022-02-28T16:11:57.000000Z" // Дата добавления продукта
      }
    }
  ]
}

Show

GET https://{subdomain}.inskill.ru/api/v3/students/{student}

Просмотр сведений о конкретном ученике.

Path Parameters

Name
Type
Description

student*

String

Уникальный ID ученика. ID ученика может быть получен в личном кабинете администратора, или при создании ученика через API

subdomain*

String

Уникальный поддомен вашего проекта

{
  // Основные данные ученика
  "data": {
    "id": 5,
    "name": "Ольга",
    "email": "user123@example.com",
    "phone": "+79123456789",
    "avatar": "https://path.to/image.jpg",
    "isActive": true // Есть ли у пользователя активный доступ к курсам? 
  },
  // Данные о продуктах ученика
  "products": [
    {
      "id": 133,
      "name": "Женщины. Дом. Новички.",
      "price": 2900.00,
      "currency": "RUB",
      "pivot": {
        "is_form_filled": 0, // Заполнена ли анкета
        "payment_id": null, // ID платежа, по которому был выдан продукт
        "is_delivered": false, // Продукт уже активирован, или нет?
        "created_at": "2022-02-28T16:11:57.000000Z" // Дата добавления продукта
      }
    }
  ]
}

Create

POST https://{subdomain}.inskill.ru/api/v3/students

Добавление нового ученика в проект.

Path Parameters

Name
Type
Description

subdomain

string

Уникальный поддомен вашего проекта

Request Body

Name
Type
Description

notify_about_product

boolean

Если true, то при добавлении продукта, клиенту будет отправлено письмо о новом продукте (содержимое письма задается в настройках проекта).

email

string

Email пользователя

name

string

ФИО пользователя

phone

string

Номер телефона в международном формате E.164. Пример: +79123456789

product

integer

ID продукта, который необходимо назначить пользователю после добавления. ID продукта можно взять на странице "Моя страница" в личном кабинете администратора.

force

boolean

Если клиент уже есть в проекте, то он будет обновлен.

{
  "data": {
    "id": 2131,
    "name": "Prof. Golden Wintheiser",
    "email": "jane43@hotmail.com",
    "phone": "+18657085469952",
    "avatar": ""
  },
  "status": "ok",
  "message": "Пользователь успешно добавлен"
}
{
  "data": {
    "id": 2131,
    "name": "Prof. Golden Wintheiser",
    "email": "jane43@hotmail.com",
    "phone": "+18657085469952",
    "avatar": ""
  },
  "message": "The given data was invalid.",
  "errors": {
    "email": [ "Пользователь с таким email уже присутствует в проекте. Воспользуйтесь методом Update для обновления пользователя." ]
  }
}

Для ученика будет создан случайный пароль и отправлено приветственное письмо.

Текст приветственного письма можно задать в настройках проекта.

Update

PATCH https://{subdomain}.inskill.ru/api/v3/students/{student}

Обновление имеющегося ученика

Path Parameters

Name
Type
Description

student*

integer

Уникальный ID ученика. ID ученика может быть получен в личном кабинете администратора, или при создании ученика через API

subdomain*

string

Уникальный поддомен вашего проекта

Request Body

Name
Type
Description

phone

string

Телефон ученика в международном формате E.164. Пример: +79123456789

name

string

ФИО ученика

product

integer

ID продукта, который необходимо назначить пользователю. ID продукта можно взять на странице "Моя страница" в личном кабинете администратора.

{
  "data": {
    "id": 1324,
    "name": "Prof. Golden Hugo",
    "email": "hu2n3@example.com",
    "phone": "+18126388729",
    "avatar": ""
  },
  "status": "ok",
  "message": "Пользователь успешно обновлен"
}
PreviousAPI

Last updated 3 years ago