curl --request GET 'https://forum.arzguard.com/api/attachments/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"attachment": {
"attachment_id": 123,
"filename": "example.txt"
}
}
Вложения
Получить данные о вложении
Возвращает описание доступного вложения без скачивания его содержимого.
GET
/
api
/
attachments
/
{id}
/
curl --request GET 'https://forum.arzguard.com/api/attachments/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"attachment": {
"attachment_id": 123,
"filename": "example.txt"
}
}
Возвращает описание доступного вложения без скачивания его содержимого.
Для временного вложения передайте секретный
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
Доступ
Передавайте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. Для уже прикреплённого файла эти значения не заменяют права на его содержимое.
Ответ
HTTP200, JSON. Схемы объектов и условные поля.
Attachment
Описание доступного вложения.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/attachments/123/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"attachment": {
"attachment_id": 123,
"filename": "example.txt"
}
}