Skip to main content
GET
Перенаправляет на миниатюру вложения с помощью ответа HTTP 301. Успех — HTTP 301 с заголовком Location. Если у файла нет миниатюры, возвращается ошибка 404. Параметр --location в cURL позволяет перейти по перенаправлению, но для просмотра самого заголовка используйте --include.

Доступ

Передавайте XF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя. Требуемые scopes: attachment:read. Все перечисленные разрешения нужны одновременно. Права текущего API-пользователя проверяются отдельно от scopes. Для Super key контекст задаётся заголовком XF-Api-User.

Параметры

string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной $FORUM_API_KEY.
integer
required
Идентификатор вложения.
string
Секретный ключ набора временных вложений, полученный через POST /attachments/new-key. Это не API-ключ из заголовка.
string
Секретный временный hash вложения. Для ещё не привязанного файла нужен подходящий hash либо key; после привязки проверяются права на содержимое.
Для временного вложения передайте секретный key либо hash в query. Для уже прикреплённого файла эти значения не заменяют права на его содержимое.

Ответ

Схемы объектов и условные поля. HTTP 301. Адрес миниатюры находится в заголовке Location, JSON-обёртки нет. Ошибки возвращаются в общей структуре errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.