Это старая версия документа!
Работа с пользователями
Получение информации о пользователе
Передаются: ключ заказчика, email и имя пользователя.
Если пользователь с таким email существует, то возвращается его идентификатор.
Если пользователь с таким email не существует, то пользователь создаётся. Ему на почту отправляется письмо с паролем. И также возвращается идентификатор только что созданного пользователя.
Запрос
- js
POST https://diktado.com/api/public/auth_user/ { "key": "String", // Ключ заказчика, для разрешения использовать апи "email": "String", // Email пользователя "login": "String" // Имя пользователя }
Ответ
- js
HTTP 200 OK Allow: POST, OPTIONS Content-Type: application/json Vary: Accept { "success": true, "user": "611c9e9b8ffa577616d4fa3c" }
Возможные коды ошибок: 400.
Пример
- js
HTTP 400 Bad Request Allow: POST, OPTIONS Content-Type: application/json Vary: Accept { "key": [ "Please enter a valid key." ], "email": [ "Введите корректный адрес электронной почты." ] }
Сохранение отчёта с результатом проверки
Передаётся: ключ заказчика, идентификатор пользователя, полученный предыдущим запросом, идентификатор диктанта, текст пользователя и модель, полученная с помощью скрипта проверки.
Запрос
- js
POST https://diktado.com/api/public/save_check_result/ { "key": "String", // Ключ заказчика "user": "String", // Идентификатор пользователя, полученный предыдущим запросом "dict": "String", // Идентификатор диктанта "text": "String", // Текст диктанта "model": "String", // Модель результата проверки, json сохраненный в строку. "sendEmailToUser"?: "Boolean" // Необязательный параметр. Если true, то пользователю на почту отправляется письмо ссылкой на результат проверки диктанта }
Ответ
- js
HTTP 200 OK Allow: POST, OPTIONS Content-Type: application/json Vary: Accept { "success": true }
Возможные коды ошибок: 400.
Пример
- js
HTTP 400 Bad Request Allow: POST, OPTIONS Content-Type: application/json Vary: Accept { "key": [ "Please enter a valid key." ], "user": [ "Please enter a valid user." ], "dict": [ "Please enter a valid dict." ], "model": [ "Please enter a valid model." ] }