Кто вошёл и в каких салонах работает
const url = 'https://app.photo-otchet.ru/api/v2/me';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.photo-otchet.ru/api/v2/me \ --header 'Authorization: Bearer <token>'Человек и его салоны с состоянием каждого — для каркаса приложения: выбрать салон, нарисовать
переключатель, отметить салоны, куда сейчас войти нельзя. Права и профиль мастера — в GET /salons/{id}/me:
они свои в каждом салоне.
Кто пришёл, его почта и салоны
Кто вошёл — без салона: человек и его салоны с состоянием каждого.
Права, роли и профиль мастера здесь не отдаются: они свои в каждом салоне, и за ними — GET /salons/{id}/me. Этот ответ — для каркаса приложения: выбрать салон и нарисовать переключатель.
object
Подтверждена ли почта: неподтверждённая не годится для писем
Необязательные письма. Отписка — для человека целиком, во всех его салонах.
object
Напоминания о сроке оплаты: за 7 дней, за день и в день
Есть ли пароль: показывать «задать пароль» или «сменить»
Видит ли сессия все салоны учётки; нет — пароль и почту из неё менять нельзя
Салоны, где человек сейчас член
Салон в общем /me: из этого строится переключатель салонов.
object
Пояс салона: в нём считаются даты его экранов
Paid | expired | locked | deletion_scheduled | blocked
Оплачено до — дата видна всем членам, деньги — нет
Подключён ли салон к системе записи; нет — плашка «подключите заново»
None | read | pay — есть ли у вас здесь billing:read и billing:pay: экран 402 выбирает между «оплатить» и «обратитесь к владельцу» без лишнего запроса
Документы человека: в pending — согласие на обработку данных, если его надо принять; в accepted — всё принятое, включая оферту, принятую салоном при установке. Правила мастера живут в салонном /salons/{id}/me: мастером человек является в конкретном салоне
object
Что осталось принять
Документ, который осталось принять.
object
Вид документа — перечисление в коде, не таблица: их шесть, они меняются вместе с кодом, и справочник из шести строк только добавил бы соединение.
Порядок объявления — порядок показа в справочнике (GET /legal/documents): сначала то, что составляет
договор, потом то, что о нас.
Метка редакции; её же присылают в ручку принятия
Постоянный адрес этой редакции на сайте
Откуда брать текст для показа — ручка нашего API со проверенной копией: её хеш записан у редакции, поэтому показанное и записанное совпадают по построению. Текста в базе может не быть (редакция заведена раньше) — тогда 404, и остаётся text_url
С какого момента редакция действует. У согласия и правил — уже наступивший момент; у оферты в плашке бывает будущее: «с этого числа действует новая редакция»
True — человек принимал прежнюю редакцию: заголовок «документы изменились»
О чём известить плашкой, не блокируя работу: новая существенная редакция оферты. Кнопка «Понятно» — та же ручка принятия
Документ, который осталось принять.
object
Вид документа — перечисление в коде, не таблица: их шесть, они меняются вместе с кодом, и справочник из шести строк только добавил бы соединение.
Порядок объявления — порядок показа в справочнике (GET /legal/documents): сначала то, что составляет
договор, потом то, что о нас.
Метка редакции; её же присылают в ручку принятия
Постоянный адрес этой редакции на сайте
Откуда брать текст для показа — ручка нашего API со проверенной копией: её хеш записан у редакции, поэтому показанное и записанное совпадают по построению. Текста в базе может не быть (редакция заведена раньше) — тогда 404, и остаётся text_url
С какого момента редакция действует. У согласия и правил — уже наступивший момент; у оферты в плашке бывает будущее: «с этого числа действует новая редакция»
True — человек принимал прежнюю редакцию: заголовок «документы изменились»
Что уже принято
Принятый документ. Адрес — принятой редакции, а не действующей: ссылка ведёт на подписанное.
object
Вид документа — перечисление в коде, не таблица: их шесть, они меняются вместе с кодом, и справочник из шести строк только добавил бы соединение.
Порядок объявления — порядок показа в справочнике (GET /legal/documents): сначала то, что составляет
договор, потом то, что о нас.
Название документа, как его называет сайт
Текст принятой редакции из нашего API — та же проверенная копия
Сведения о субъекте, какими они были в момент принятия.
Просмотр принятого документа подставляет только их: сегодняшние данные показали бы документ, которого человек не принимал.
Пример
{ "email_confirmed": false, "mail_preferences": { "renewal_reminders": true }, "salons": [ { "billing_access": "none" } ], "legal": { "pending": [ { "document": "offer" } ], "notices": [ { "document": "offer" } ], "accepted": [ { "document": "offer" } ] }}Нет действующего входа: нет куки или токена, сессия истекла, токен отозван
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "reason": "unauthenticated"}Прав на это действие нет: не хватает политики или запрещён способ входа
Отказ приложения: текст человеку и причина программе.
Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен.
Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» —
в docs/api/1.0.md, раздел «Формат ошибки».
object
Текст для человека — показывается как есть
Причина отказа: по ней ветвится клиент
Пример
{ "reason": "unauthenticated"}Запрос не прошёл проверку схемы
Запрос не прошёл проверку схемы: единственный отказ, у которого detail — массив.
У доменных отказов detail строкой и reason: invalid (ErrorResponse), так что различать формы
можно по reason, а не по типу detail.
object
Одна ошибка схемы запроса.
object
Где именно: body, имя поля, индекс в списке
Вид ошибки от pydantic: value_error, int_parsing, missing…
Текст ошибки
Текст написан для человека и готов к показу (value_error — наш валидатор). false — встроенный текст pydantic на английском: показывайте свою формулировку
Пример
{ "reason": "validation"}