Pular para o conteúdo

Feedback ​

Relatórios com capturas de tela e logs enviados à ProAnimaStudio por meio deste servidor.

Operações deste grupo com a regra de acesso, a regra de repetição, os parâmetros e as respostas. Toda solicitação leva uma chave: Authorization: Bearer <chave> (consulte “Autenticação”).

Operações ​

Enviar feedback à ProAnimaStudio ​

POST /api/v1/feedback

Acesso: Qualquer chave ou sessão válida · Repetição: Não repetir automaticamente

Encaminha uma mensagem, por meio deste servidor, ao hub da ProAnimaStudio e responde 202 com o id do hub. Envie message (até 20 000 caracteres), lang (ru ou en), serverLog (true anexa o log deste servidor e um resumo do sistema, somente para administradores) e, opcionalmente, email para uma resposta, screen, até 6 screenshots em base64 (PNG, JPEG, WebP ou GIF, 8 MiB cada) e o clientLog do console; o total é limitado a 15 MiB. Nenhuma nova tentativa é feita, portanto uma segunda chamada é uma segunda mensagem. 503 feedback_disabled quando o operador o desativou, 503 hub_unreachable quando o hub não responde, 429 feedback_attempts quando este servidor enviou demais.

Corpo da solicitação (application/json)

CampoTipoObrigatórioRegras
messagestringsim1–20000 caracteres
emailstringnãoaté 254 caracteres; pode ser null
langstringsimum destes: ru, en
screenstringnãoaté 11 caracteres; pode ser null
screenshotsarray de objectsimaté 6 itens
screenshots[].namestringsim1–120 caracteres
screenshots[].typestringsimum destes: image/png, image/jpeg, image/webp, image/gif
screenshots[].datastring (byte)sim—
clientLogstringnãoaté 2097152 caracteres; pode ser null
serverLogbooleansim—

Resposta 202

CampoTipoObrigatórioRegras
idstringsim—

Respostas: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Exemplo

bash
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}'

Pré-visualizar os anexos do feedback ​

GET HEAD /api/v1/feedback/attachments

Acesso: Administrador · Repetição: Pode ser repetida com segurança (leitura)

Retorna os dois textos que sendFeedback anexa quando serverLog é true: os registros recentes do log deste servidor e um resumo do sistema (versões, sistema operacional, estados de atualização e de espelho) sem endereços, nomes nem segredos. Mostre-os ao administrador antes de enviar.

Resposta 200

CampoTipoObrigatórioRegras
serverLogstringsim—
systemstringsim—

Respostas: 200, 400, 401, 403, 404, 409, 422, 503, 507

Exemplo

bash
curl -X GET "$ARKVORY_URL/api/v1/feedback/attachments" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Arkvory · ProAnimaStudio