curl --request POST 'https://forum.arzguard.com/api/attachments/new-key' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--form 'type=post' \
--form 'context[node_id]=123'
{
"key": "EXAMPLE_ATTACHMENT_KEY"
}
Вложения
Создать ключ вложений
Создаёт набор временных вложений для будущего сообщения или другого контента.
POST
/
api
/
attachments
/
new-key
curl --request POST 'https://forum.arzguard.com/api/attachments/new-key' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--form 'type=post' \
--form 'context[node_id]=123'
{
"key": "EXAMPLE_ATTACHMENT_KEY"
}
Создаёт набор временных вложений для будущего сообщения или другого контента.
Контекст должен соответствовать будущему содержимому: для нового поста —
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
type=post и context[node_id]; для ответа в переписке — type=conversation_message и context[conversation_id]. Для новой переписки используется conversation_message без контекста. Файл при создании ключа необязателен. Сохраняйте ключ как секрет.
Доступ
Передавайте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 или conversation_message. Доступные типы зависят от установленных обработчиков.string[]
Именованные значения контекста: передавайте как
context[node_id]=123 или другой набор, соответствующий будущему содержимому.file
Файл вложения. Передаётся файловой частью
multipart/form-data.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
string
Секретный ключ созданного набора вложений. Используется для загрузок и последующей привязки к контенту.
Attachment
Описание первого вложения. Поле возвращается, только если вместе с ключом успешно загружен файл.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/attachments/new-key' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--form 'type=post' \
--form 'context[node_id]=123'
{
"key": "EXAMPLE_ATTACHMENT_KEY"
}