Перейти к содержимому

Кто вошёл и в каких салонах работает

GET
/api/v2/me
curl --request GET \
--url https://app.photo-otchet.ru/api/v2/me \
--header 'Authorization: Bearer <token>'

Человек и его салоны с состоянием каждого — для каркаса приложения: выбрать салон, нарисовать переключатель, отметить салоны, куда сейчас войти нельзя. Права и профиль мастера — в GET /salons/{id}/me: они свои в каждом салоне.

Кто пришёл, его почта и салоны

Media type application/json
GeneralMeResponse

Кто вошёл — без салона: человек и его салоны с состоянием каждого.

Права, роли и профиль мастера здесь не отдаются: они свои в каждом салоне, и за ними — GET /salons/{id}/me. Этот ответ — для каркаса приложения: выбрать салон и нарисовать переключатель.

object
id
required
Id
integer
login
Any of:
string
name
Any of:
string
last_login_at
Any of:
string format: date-time
email
Any of:
string
email_confirmed
Email Confirmed

Подтверждена ли почта: неподтверждённая не годится для писем

boolean
email_pending
Any of:
string
mail_preferences
MailPreferences

Необязательные письма. Отписка — для человека целиком, во всех его салонах.

object
renewal_reminders
Renewal Reminders

Напоминания о сроке оплаты: за 7 дней, за день и в день

boolean
default: true
has_password
required
Has Password

Есть ли пароль: показывать «задать пароль» или «сменить»

boolean
full_scope
required
Full Scope

Видит ли сессия все салоны учётки; нет — пароль и почту из неё менять нельзя

boolean
salons
Salons

Салоны, где человек сейчас член

Array<object>
MySalon

Салон в общем /me: из этого строится переключатель салонов.

object
id
required
Id
integer
name
required
Name
string
timezone
required
Timezone

Пояс салона: в нём считаются даты его экранов

string
state
required
State

Paid | expired | locked | deletion_scheduled | blocked

string
paid_until
required
Paid Until

Оплачено до — дата видна всем членам, деньги — нет

string format: date-time
delete_after
Any of:
string format: date-time
connected
required
Connected

Подключён ли салон к системе записи; нет — плашка «подключите заново»

boolean
blocked_reason
Any of:
string
billing_access
Billing Access

None | read | pay — есть ли у вас здесь billing:read и billing:pay: экран 402 выбирает между «оплатить» и «обратитесь к владельцу» без лишнего запроса

string
default: none
legal
LegalInfo

Документы человека: в pending — согласие на обработку данных, если его надо принять; в accepted — всё принятое, включая оферту, принятую салоном при установке. Правила мастера живут в салонном /salons/{id}/me: мастером человек является в конкретном салоне

object
pending
Pending

Что осталось принять

Array<object>
PendingDocument

Документ, который осталось принять.

object
document
required
LegalDocument

Вид документа — перечисление в коде, не таблица: их шесть, они меняются вместе с кодом, и справочник из шести строк только добавил бы соединение.

Порядок объявления — порядок показа в справочнике (GET /legal/documents): сначала то, что составляет договор, потом то, что о нас.

string
Allowed values: offer pricing privacy consent master_rules requisites
revision
required
Revision

Метка редакции; её же присылают в ручку принятия

string
url
required
Url

Постоянный адрес этой редакции на сайте

string
text_api_url
required
Text Api Url

Откуда брать текст для показа — ручка нашего API со проверенной копией: её хеш записан у редакции, поэтому показанное и записанное совпадают по построению. Текста в базе может не быть (редакция заведена раньше) — тогда 404, и остаётся text_url

string
text_url
Any of:
string
title
required
Title
string
effective_from
required
Effective From

С какого момента редакция действует. У согласия и правил — уже наступивший момент; у оферты в плашке бывает будущее: «с этого числа действует новая редакция»

string format: date-time
reacceptance
required
Reacceptance

True — человек принимал прежнюю редакцию: заголовок «документы изменились»

boolean
notices
Notices

О чём известить плашкой, не блокируя работу: новая существенная редакция оферты. Кнопка «Понятно» — та же ручка принятия

Array<object>
PendingDocument

Документ, который осталось принять.

object
document
required
LegalDocument

Вид документа — перечисление в коде, не таблица: их шесть, они меняются вместе с кодом, и справочник из шести строк только добавил бы соединение.

Порядок объявления — порядок показа в справочнике (GET /legal/documents): сначала то, что составляет договор, потом то, что о нас.

string
Allowed values: offer pricing privacy consent master_rules requisites
revision
required
Revision

Метка редакции; её же присылают в ручку принятия

string
url
required
Url

Постоянный адрес этой редакции на сайте

string
text_api_url
required
Text Api Url

Откуда брать текст для показа — ручка нашего API со проверенной копией: её хеш записан у редакции, поэтому показанное и записанное совпадают по построению. Текста в базе может не быть (редакция заведена раньше) — тогда 404, и остаётся text_url

string
text_url
Any of:
string
title
required
Title
string
effective_from
required
Effective From

С какого момента редакция действует. У согласия и правил — уже наступивший момент; у оферты в плашке бывает будущее: «с этого числа действует новая редакция»

string format: date-time
reacceptance
required
Reacceptance

True — человек принимал прежнюю редакцию: заголовок «документы изменились»

boolean
accepted
Accepted

Что уже принято

Array<object>
AcceptedDocument

Принятый документ. Адрес — принятой редакции, а не действующей: ссылка ведёт на подписанное.

object
document
required
LegalDocument

Вид документа — перечисление в коде, не таблица: их шесть, они меняются вместе с кодом, и справочник из шести строк только добавил бы соединение.

Порядок объявления — порядок показа в справочнике (GET /legal/documents): сначала то, что составляет договор, потом то, что о нас.

string
Allowed values: offer pricing privacy consent master_rules requisites
title
required
Title

Название документа, как его называет сайт

string
revision
required
Revision
string
url
required
Url
string
text_api_url
required
Text Api Url

Текст принятой редакции из нашего API — та же проверенная копия

string
text_url
Any of:
string
accepted_at
required
Accepted At
string format: date-time
subject
Any of:
AcceptedSubject

Сведения о субъекте, какими они были в момент принятия.

Просмотр принятого документа подставляет только их: сегодняшние данные показали бы документ, которого человек не принимал.

object
user_name
Any of:
string
user_login
Any of:
string
salon_name
Any of:
string

Пример

{
"email_confirmed": false,
"mail_preferences": {
"renewal_reminders": true
},
"salons": [
{
"billing_access": "none"
}
],
"legal": {
"pending": [
{
"document": "offer"
}
],
"notices": [
{
"document": "offer"
}
],
"accepted": [
{
"document": "offer"
}
]
}
}

Нет действующего входа: нет куки или токена, сессия истекла, токен отозван

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Прав на это действие нет: не хватает политики или запрещён способ входа

Media type application/json
ErrorResponse

Отказ приложения: текст человеку и причина программе.

Ветвиться нужно по reason — текст detail переписывают, и ломаться об это клиент не должен. Поля причины приходят рядом и зависят от неё; перечень причин с таблицей «когда и где» — в docs/api/1.0.md, раздел «Формат ошибки».

object
detail
required
Detail

Текст для человека — показывается как есть

string
reason
required
Reason

Причина отказа: по ней ветвится клиент

string
Allowed values: unauthenticated policy forbidden not_found conflict bad_request invalid validation too_many_attempts salon_expired salon_blocked acceptance_required archive_not_ready archive_too_many transcode_unavailable
policy
Any of:
string
limit
Any of:
integer
retry_at
Any of:
string format: date-time
state
Any of:
string
paid_until
Any of:
string format: date-time

Пример

{
"reason": "unauthenticated"
}

Запрос не прошёл проверку схемы

Media type application/json
ValidationErrorResponse

Запрос не прошёл проверку схемы: единственный отказ, у которого detail — массив.

У доменных отказов detail строкой и reason: invalid (ErrorResponse), так что различать формы можно по reason, а не по типу detail.

object
detail
required
Detail
Array<object>
ValidationItem

Одна ошибка схемы запроса.

object
loc
required
Loc

Где именно: body, имя поля, индекс в списке

Array<string>
type
required
Type

Вид ошибки от pydantic: value_error, int_parsing, missing…

string
msg
required
Msg

Текст ошибки

string
for_user
required
For User

Текст написан для человека и готов к показу (value_error — наш валидатор). false — встроенный текст pydantic на английском: показывайте свою формулировку

boolean
reason
Reason
string
default: validation
Allowed value: validation

Пример

{
"reason": "validation"
}