curl --request POST 'https://forum.arzguard.com/api/attachments/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--form 'key=EXAMPLE_ATTACHMENT_KEY' \
--form 'attachment=@/path/to/example.txt'
{
"attachment": {
"attachment_id": 123,
"filename": "example.txt"
}
}
Вложения
Загрузить вложение
Загружает файл в набор вложений, связанный с ранее созданным ключом.
POST
/
api
/
attachments
/
curl --request POST 'https://forum.arzguard.com/api/attachments/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--form 'key=EXAMPLE_ATTACHMENT_KEY' \
--form 'attachment=@/path/to/example.txt'
{
"attachment": {
"attachment_id": 123,
"filename": "example.txt"
}
}
Загружает файл в набор вложений, связанный с ранее созданным ключом.
Сначала создайте ключ через POST /attachments/new-key. Создатель ключа и текущий API-пользователь должны совпадать; иначе возвращается
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
attachment_key_user_wrong. Затем передайте этот ключ в метод создания или изменения сообщения как attachment_key.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: attachment:write. Все перечисленные разрешения нужны одновременно.
Права текущего API-пользователя проверяются отдельно от scopes. Для Super key контекст задаётся заголовком XF-Api-User.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.multipart/form-data. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
string
required
Секретный ключ набора временных вложений, полученный через
POST /attachments/new-key. Это не API-ключ из заголовка.file
required
Файл вложения. Передаётся файловой частью
multipart/form-data.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
Attachment
Описание успешно загруженного вложения.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/attachments/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--form 'key=EXAMPLE_ATTACHMENT_KEY' \
--form 'attachment=@/path/to/example.txt'
{
"attachment": {
"attachment_id": 123,
"filename": "example.txt"
}
}