Aller au contenu

Commentaires ​

Rapports avec captures d’écran et journaux envoyés à ProAnimaStudio via ce serveur.

Opérations de ce groupe, avec leur règle d’accès, leur règle de nouvelle tentative, leurs paramètres et leurs réponses. Chaque requête porte une clé : Authorization: Bearer <clé> (voir « Authentification »).

Opérations ​

Envoyer des commentaires à ProAnimaStudio ​

POST /api/v1/feedback

Accès: Toute clé ou session valide · Nouvelle tentative: Ne pas répéter automatiquement

Transmet un message par ce serveur au hub ProAnimaStudio et répond 202 avec l’id du hub. Envoyez message (20 000 caractères au plus), lang (ru ou en), serverLog (true joint le journal de ce serveur et un résumé du système, administrateurs uniquement) et, facultativement, email pour une réponse, screen, jusqu’à 6 screenshots en base64 (PNG, JPEG, WebP ou GIF, 8 MiB chacune) et le clientLog de la console ; le total est limité à 15 MiB. Aucune nouvelle tentative n’est faite automatiquement : un second appel est donc un second message. 503 feedback_disabled lorsque l’opérateur l’a désactivé, 503 hub_unreachable lorsque le hub ne répond pas, 429 feedback_attempts lorsque ce serveur en a trop envoyé.

Corps de la requête (application/json)

ChampTypeObligatoireRègles
messagestringoui1–20000 caractères
emailstringnonjusqu’à 254 caractères; peut être null
langstringouiune valeur parmi ru, en
screenstringnonjusqu’à 11 caractères; peut être null
screenshotstableau de objectouijusqu’à 6 éléments
screenshots[].namestringoui1–120 caractères
screenshots[].typestringouiune valeur parmi image/png, image/jpeg, image/webp, image/gif
screenshots[].datastring (byte)oui—
clientLogstringnonjusqu’à 2097152 caractères; peut être null
serverLogbooleanoui—

Réponse 202

ChampTypeObligatoireRègles
idstringoui—

Réponses: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Exemple

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évisualiser les pièces jointes des commentaires ​

GET HEAD /api/v1/feedback/attachments

Accès: Administrateur · Nouvelle tentative: Peut être répétée sans risque (lecture)

Renvoie les deux textes que sendFeedback joint lorsque serverLog vaut true : les enregistrements récents du journal de ce serveur et un résumé du système (versions, système d’exploitation, états des mises à jour et des miroirs) sans adresses, noms ni secrets. Montrez-les à l’administrateur avant l’envoi.

Réponse 200

ChampTypeObligatoireRègles
serverLogstringoui—
systemstringoui—

Réponses: 200, 400, 401, 403, 404, 409, 422, 503, 507

Exemple

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

Arkvory · ProAnimaStudio