Все API точки проекта "Мой сосед". - simvolice/myneighbornew GitHub Wiki
Документация по API точкам проекта "Мой сосед"
Название API точки: "Получить CSRF токен."
- Метод запроса: "GET"
- Адрес API точки: "/getcsrftoken"
- Возврат значения в случае успеха:
{"tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}
- Возврат значения в случае ошибки: отсутствует
Название API точки: "Если на сервере упадет база данных"
- Метод запроса: "Любой"
- Адрес API точки: "Любой"
- Возврат значения в случае успеха:
{"code":"connectDBFailed"}
- Возврат значения в случае ошибки: отсутствует
Название API точки: "Если не предоставлен CSRF токен"
- Метод запроса: "Любой"
- Адрес API точки: "Любой"
- Возврат значения в случае успеха:
{"code":"noCsrfToken"}
- Возврат значения в случае ошибки: отсутствует
Название API точки: "Войти в систему"
- Метод запроса: "POST"
- Адрес API точки: "/login"
- Что нужно передать клиенту:
{"email": "[email protected]", "pass": "qwerty", "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}
- Возврат значения в случае успеха:
{"code": "ok", "token": "gfdjhgjfdhgj4543543534"}
- Возврат значения в случае ошибки:
{"code": "emailWrongRegExp"} || {"code": "passWrongRegExp"} || {"code": "passWrong"}
Название API точки: "Регистрация нового пользователя в системе"
- Метод запроса: "POST"
- Адрес API точки: "/register"
- Что нужно передать клиенту:
{"email": "[email protected]", "pass": "qwerty", "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}
- Возврат значения в случае успеха:
{"code": "ok"}
- Возврат значения в случае ошибки:
{"code": "emailWrongRegExp"} || {"code": "passWrongRegExp"}
Название API точки: "Регистрация нового пользователя в системе"
- Метод запроса: "POST"
- Адрес API точки: "/register"
- Что нужно передать клиенту:
{"email": "[email protected]", "pass": "qwerty", "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}
- Возврат значения в случае успеха:
{"code": "ok"}
- Возврат значения в случае ошибки:
{"code": "emailWrongRegExp"} || {"code": "passWrongRegExp"} || {"code": "Может вернуться иной код ошибки из базы"}
Название API точки: "Сброс текущего пароля в системе"
- Метод запроса: "POST"
- Адрес API точки: "/resetpass"
- Что нужно передать клиенту:
{"email": "[email protected]", "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}
- Возврат значения в случае успеха:
{"code": "ok"}
- Возврат значения в случае ошибки:
{"code": "emailWrongRegExp"}
Название API точки: "Установка нового пароля в системе"
- Метод запроса: "POST"
- Адрес API точки: "/setnewpass"
- Что нужно передать клиенту:
{"pass": "qwerty", "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}
- Возврат значения в случае успеха:
{"code": "ok"}
- Возврат значения в случае ошибки:
{"code": "passWrongRegExp"}
Название API точки: "Редактировать личный профиль пользователя"
- Метод запроса: "POST"
- Адрес API точки: "/editmyprofile"
- Что нужно передать клиенту:
{"token": "fgfdgdf56456546", "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716"}, остальные поля уточним в дальнейшем
- Возврат значения в случае успеха:
{"code": "ok"}
- Возврат значения в случае ошибки:
{"code": "nullValues"}
Название API точки: "Поиск по алгоритму ближней сосед"
- Метод запроса: "POST"
- Адрес API точки: "/searchgeo"
- Что нужно передать клиенту:
{"coord": [0.54, 0.5689], "tokencsrf":"d6a69925-424d-43f9-93bd-a8a33e2a7716", "search": "Пицерии"}
- Возврат значения в случае успеха:
{"code": "ok", "result": [array] }
- Возврат значения в случае ошибки:
{"code": "coordNull"} || {"code": "searchNull"}