Emdesell API (beta)

Аутентификация

Для аутентификации запросов ожидается заголовок X-Api-Key, содержащий себе ключ, сгенерированный в Настройках школы на вкладке API

Базовый URL API находится по адресу вашей школы + '/api'. Пример адреса: https://myschool.emdesell.ru/api

AUTHORIZATIONAPI Key

Key

X-Api-Key

Value

Accounts

/accounts

AUTHORIZATIONAPI Key

This folder is using API Key from collectionEmdesell API (beta)

POSTCreate

{{base_url}}/accounts/create

Создание аккаунта

AUTHORIZATIONAPI Key

This request is using API Key from collectionEmdesell API (beta)

Bodyurlencoded

password

Пароль

first_name

Имя

last_name

Фамилия

patronymic

Отчество

phone

Номер телефона

role

student

Роль (student, author, admin)

email_confirmed

Признак подтверждения email-адреса

send_email

Отправить email при создании аккаунта

interface_language

system

Язык интерфейса

bothelp_cuid

Необязательно, Cuid Bothelp

vk_id

Необязательно, VK I

telegram_id

Необязательно, Telegram ID

salebot_id

Необязательно, Salebot ID

Example Request

curl

curl --location -g '{{base_url}}/accounts/create' \
--data-urlencode 'email=test@testemdesell.ru' \
--data-urlencode 'password=usergoodpassword' \
--data-urlencode 'first_name=Тестов' \
--data-urlencode 'last_name=Тест' \
--data-urlencode 'patronymic=Тестович' \
--data-urlencode 'phone=+79111111111' \
--data-urlencode 'role=student' \
--data-urlencode 'email_confirmed=1' \
--data-urlencode 'send_email=0' \
--data-urlencode 'interface_language=system' \
--data-urlencode 'bothelp_cuid=' \
--data-urlencode 'vk_id=' \
--data-urlencode 'telegram_id=' \
--data-urlencode 'salebot_id='

200 OK

Example Response

json

{
  "status": "success",
  "result": {
    "account": {
      "id": 1,
      "email": "test@testemdesell.ru",
      "first_name": "Тестов",
      "last_name": "Тест",
      "patronymic": "Тестович",
      "phone": "+79111111111",
      "role": "student"
    }
  }
}

Server

nginx/1.16.1

Date

Fri, 12 Jan 2024 09:16:24 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Vary

Accept-Encoding

Strict-Transport-Security

max-age=31536000;

Content-Encoding

gzip

POSTEdit

{{base_url}}/accounts/edit

Редактирование аккаунта

AUTHORIZATIONAPI Key

This request is using API Key from collectionEmdesell API (beta)

Bodyurlencoded

ID аккаунта

Необязательно, Email

password

Необязательно, Пароль

first_name

Необязательно, имя

last_name

Необязательно, Фамилия

patronymic

Необязательно, Отчество

phone

Необязательно, Номер телефона

role

Необязательно, Роль (student, author, admin)

email_confirmed

Необязательно, Признак подтверждения email-адреса

interface_language

Необязательно, Язык интерфейса

bothelp_cuid

Необязательно, Cuid Bothelp

vk_id

Необязательно, VK I

telegram_id

Необязательно, Telegram ID

salebot_id

Необязательно, Salebot ID

Example Request

curl

curl --location -g '{{base_url}}/accounts/edit' \
--data-urlencode 'id=1' \
--data-urlencode 'email=' \
--data-urlencode 'password=' \
--data-urlencode 'first_name=' \
--data-urlencode 'last_name=' \
--data-urlencode 'patronymic=' \
--data-urlencode 'phone=' \
--data-urlencode 'role=' \
--data-urlencode 'email_confirmed=' \
--data-urlencode 'interface_language=' \
--data-urlencode 'bothelp_cuid=' \
--data-urlencode 'vk_id=' \
--data-urlencode 'telegram_id=' \
--data-urlencode 'salebot_id='

200 OK

Example Response

json

{
  "status": "success",
  "result": {
    "account": {
      "id": 1,
      "email": "test@test.ru",
      "first_name": "Test",
      "last_name": "Testov",
      "patronymic": "Testovich",
      "phone": "+7",
      "role": "student",
      "bothelp_cuid": null,
      "vk_id": null,
      "telegram_id": null
    }
  }
}

Server

nginx/1.16.1

Date

Tue, 25 Jun 2024 12:47:51 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Vary

Accept-Encoding

X-Powered-By

PHP/8.2.11

Strict-Transport-Security

max-age=31536000;

Content-Encoding

gzip

GETList accounts

{{base_url}}/accounts/list?count=20&offset=0&role=all&sort=id_desc

Список аккаунтов

AUTHORIZATIONAPI Key

This request is using API Key from collectionEmdesell API (beta)

PARAMS

count

Не более 200

offset

Смещение указателя

role

all

Необязательное, по умолчанию - all

sort

id_desc

Необязательное, по умолчанию - id_desc

Example Request

curl

curl --location -g '{{base_url}}/accounts/list?count=3&offset=0&role=all&sort=id_desc'

200 OK

Example Response

json

{
  "status": "success",
  "result": {
    "accounts": [
      {
        "id": 3,
        "email": "test@testemdesell.ru",
        "first_name": "Тестов",
        "last_name": "Тест",
        "patronymic": "Тестович",
        "phone": "+79111111111",
        "role": "student",
        "bothelp_cuid": null,
        "vk_id": 11111,
        "telegram_id": null,
        "salebot_id": null
      },
      {
        "id": 2,
        "email": "admin@testemdesell.ru",
        "first_name": "Админов",
        "last_name": "Админ",
        "patronymic": "Админович",
        "phone": "+79000000000",
        "role": "admin",
        "bothelp_cuid": null,
        "vk_id": null,
        "telegram_id": 22222,
        "salebot_id": null
      },
      {
        "id": 1,
        "email": "author@testemdesell.ru",
        "first_name": "Авторов",
        "last_name": "Автор",
        "patronymic": "Авторович",
        "phone": "+79222222222",
        "role": "author",
        "bothelp_cuid": null,
        "vk_id": null,
        "telegram_id": null,
        "salebot_id": 33333
      }
    ]
  }
}

Server

nginx/1.16.1

Date

Fri, 12 Jan 2024 09:18:45 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

Vary

Accept-Encoding

Strict-Transport-Security

max-age=31536000;

Content-Encoding

gzip