curl --request GET 'https://forum.arzguard.com/api/attachments/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--get \
--data-urlencode 'key=EXAMPLE_ATTACHMENT_KEY'
{
"attachments": []
}
Вложения
Получить временные вложения
Возвращает ещё не прикреплённые к контенту файлы по ключу загрузки.
GET
/
api
/
attachments
/
curl --request GET 'https://forum.arzguard.com/api/attachments/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--get \
--data-urlencode 'key=EXAMPLE_ATTACHMENT_KEY'
{
"attachments": []
}
Возвращает ещё не прикреплённые к контенту файлы по ключу загрузки.
Метод предназначен для файлов, ещё не привязанных к содержимому. Для вложений опубликованного сообщения получайте его объект и список вложений через соответствующий метод сообщений.
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: attachment:read. Все перечисленные разрешения нужны одновременно.
Права текущего API-пользователя проверяются отдельно от scopes. Для Super key контекст задаётся заголовком XF-Api-User.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.string
required
Секретный ключ набора временных вложений, полученный через
POST /attachments/new-key. Это не API-ключ из заголовка.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
Attachment[]
Список временных вложений набора.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/attachments/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--get \
--data-urlencode 'key=EXAMPLE_ATTACHMENT_KEY'
{
"attachments": []
}