curl --request GET 'https://forum.arzguard.com/api/attachments/123/data' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--output 'example-attachment.bin'
HTTP/1.1 200 OK
... байты файла ...
Вложения
Скачать вложение
Возвращает содержимое вложения в бинарном виде.
GET
/
api
/
attachments
/
{id}
/
data
curl --request GET 'https://forum.arzguard.com/api/attachments/123/data' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--output 'example-attachment.bin'
HTTP/1.1 200 OK
... байты файла ...
Возвращает содержимое вложения в бинарном виде.
Успешный ответ содержит байты файла, а не JSON. Получение уже привязанного вложения может учитывать его просмотр: обработчик вызывает
Для временного вложения передайте секретный
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
logAttachmentView. Это относится и к GET-запросу. При совпавшем условном запросе If-None-Match обработчик выбирает ответ без повторной передачи файла. Не используйте универсальный JSON-парсер для бинарного ответа.
Доступ
Передавайте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 200 с бинарным содержимым файла. JSON-обёртки нет. Ошибки возвращаются в общей структуреerrors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/attachments/123/data' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--output 'example-attachment.bin'
HTTP/1.1 200 OK
... байты файла ...