Обратная связь
Отчёты со снимками экрана и журналами для ProAnimaStudio через этот сервер.
Операции этой группы с правилом доступа, правилом повтора, параметрами и ответами. Каждый запрос несёт ключ: Authorization: Bearer <ключ> (см. «Аутентификация»).
Операции
Отправить обратную связь в ProAnimaStudio
POST /api/v1/feedback
Доступ: Любой действующий ключ или сессия · Повтор: Не повторять автоматически
Пересылает сообщение через этот сервер хабу ProAnimaStudio и отвечает 202 с id от хаба. Передайте message (до 20 000 символов), lang (ru или en), serverLog (true прикладывает журнал этого сервера и системную сводку, только для администраторов) и при желании email для ответа, screen, до 6 снимков экрана screenshots в base64 (PNG, JPEG, WebP или GIF, по 8 МиБ каждый) и clientLog консоли; общий размер ограничен 15 МиБ. Автоматических повторов нет, поэтому второй вызов — это второе сообщение. 503 feedback_disabled, если оператор отключил отправку, 503 hub_unreachable, если хаб не отвечает, 429 feedback_attempts, если с этого сервера отправлено слишком много.
Тело запроса (application/json)
| Поле | Тип | Обязателен | Правила |
|---|---|---|---|
message | string | да | 1–20000 символов |
email | string | нет | не длиннее 254 символов; может быть null |
lang | string | да | одно из ru, en |
screen | string | нет | не длиннее 11 символов; может быть null |
screenshots | массив object | да | не больше 6 элементов |
screenshots[].name | string | да | 1–120 символов |
screenshots[].type | string | да | одно из image/png, image/jpeg, image/webp, image/gif |
screenshots[].data | string (byte) | да | — |
clientLog | string | нет | не длиннее 2097152 символов; может быть null |
serverLog | boolean | да | — |
Ответ 202
| Поле | Тип | Обязателен | Правила |
|---|---|---|---|
id | string | да | — |
Ответы: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507
Пример
curl -X POST "$ARKVORY_URL/api/v1/feedback" \
-H "Authorization: Bearer $ARKVORY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"message":"<message>","lang":"ru","screenshots":[],"serverLog":false}'Просмотреть вложения обратной связи
GET HEAD /api/v1/feedback/attachments
Доступ: Администратор · Повтор: Можно повторять (чтение)
Возвращает два текста, которые sendFeedback прикладывает при serverLog, равном true: последние записи журнала этого сервера и системную сводку (версии, операционная система, состояния обновления и зеркал) без адресов, имён и секретов. Покажите их администратору перед отправкой.
Ответ 200
| Поле | Тип | Обязателен | Правила |
|---|---|---|---|
serverLog | string | да | — |
system | string | да | — |
Ответы: 200, 400, 401, 403, 404, 409, 422, 503, 507
Пример
curl -X GET "$ARKVORY_URL/api/v1/feedback/attachments" \
-H "Authorization: Bearer $ARKVORY_TOKEN"