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

Скачать ZIP-архив фото

GET
/api/v2/salons/{salon_id}/photos/archive/{job_id}/file
curl --request GET \
--url https://app.photo-otchet.ru/api/v2/salons/1/photos/archive/7f3a9c1e/file \
--header 'Authorization: Bearer <token>'

Архив «как есть» отдаётся потоком из хранилища, без сжатия. Пережатый — 302 на подписанную ссылку хранилища: подпись выпускается в момент запроса, поэтому следить за её сроком не нужно. Переходить навигацией (window.location или <a download>), а не fetch: это не межисточниковый запрос, и правила CORS к нему не применяются.

job_id
required
Job Id

Заказ архива

string
>= 8 characters <= 64 characters

Заказ архива

salon_id
required
Salon Id

Салон

integer
>= 1

Салон

ZIP-архив

Media type application/zip

Подписанная ссылка на собранный архив в заголовке Location

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

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"
}

Срок салона кончился: reason: salon_expired, в теле state и paid_until

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
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

Пример

{
"detail": "Архива нет: он истёк, удалён или заказан другим человеком"
}

Архив ещё не готов

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

Пример

{
"detail": "Архив ещё собирается — спросите состояние и дождитесь готовности"
}

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

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"
}

Салон заблокирован оператором: reason: salon_blocked, причина в blocked_reason

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

Примеры

Салон уже собирает

{
"detail": "Салон уже собирает архивы — дождитесь, пока закончится хотя бы один, и повторите"
}