انتقل إلى المحتوى

الملاحظات ​

تقارير مع لقطات شاشة وسجلات تُرسل إلى ProAnimaStudio عبر هذا الخادم.

عمليات هذه المجموعة مع قاعدة الوصول وقاعدة إعادة المحاولة والمعلمات والاستجابات. يحمل كل طلب مفتاحًا: Authorization: Bearer <key> (راجع «المصادقة»).

العمليات ​

إرسال ملاحظات إلى ProAnimaStudio ​

POST /api/v1/feedback

الوصول: أي مفتاح أو جلسة صالحة · إعادة المحاولة: لا تكرّره تلقائيًا

يمرّر رسالة عبر هذا الخادم إلى مركز ProAnimaStudio (hub) ويردّ بـ 202 مع id الذي يعطيه المركز. أرسل message (حتى 20 000 حرف)، وlang (ru أو en)، وserverLog (القيمة true ترفق سجل هذا الخادم وملخصًا للنظام، للمسؤولين فقط)، واختياريًا email للردّ، وscreen، وحتى 6 لقطات شاشة screenshots بترميز base64 (PNG أو JPEG أو WebP أو GIF، 8 MiB لكل منها) وclientLog الخاص بوحدة التحكم؛ ويُحدّ المجموع بـ 15 MiB. لا تُعاد أي محاولة تلقائيًا، فالاستدعاء الثاني رسالة ثانية. والنتيجة 503 feedback_disabled إذا عطّل المشغّل الميزة، و503 hub_unreachable إذا لم يردّ المركز، و429 feedback_attempts إذا أرسل هذا الخادم أكثر من اللازم.

نص الطلب (application/json)

الحقلالنوعمطلوبالقواعد
messagestringنعمعدد الأحرف: 1–20000
emailstringلاعدد الأحرف: 254 كحد أقصى; يمكن أن يكون null
langstringنعمإحدى القيم: ru, en
screenstringلاعدد الأحرف: 11 كحد أقصى; يمكن أن يكون null
screenshotsمصفوفة من objectنعمعدد العناصر: 6 كحد أقصى
screenshots[].namestringنعمعدد الأحرف: 1–120
screenshots[].typestringنعمإحدى القيم: image/png, image/jpeg, image/webp, image/gif
screenshots[].datastring (byte)نعم—
clientLogstringلاعدد الأحرف: 2097152 كحد أقصى; يمكن أن يكون null
serverLogbooleanنعم—

الاستجابة 202

الحقلالنوعمطلوبالقواعد
idstringنعم—

الاستجابات: 202, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

مثال

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

معاينة مرفقات الملاحظات ​

GET HEAD /api/v1/feedback/attachments

الوصول: مسؤول · إعادة المحاولة: آمن للتكرار (قراءة)

يعيد النصّين اللذين يرفقهما sendFeedback عندما تكون serverLog هي true: السجلات الأخيرة لسجل هذا الخادم وملخصًا للنظام (الإصدارات ونظام التشغيل وحالتا التحديث والمرآة) دون عناوين أو أسماء أو أسرار. اعرضهما على المسؤول قبل الإرسال.

الاستجابة 200

الحقلالنوعمطلوبالقواعد
serverLogstringنعم—
systemstringنعم—

الاستجابات: 200, 400, 401, 403, 404, 409, 422, 503, 507

مثال

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

Arkvory · ProAnimaStudio