توثيق API

هذا هو التوثيق لنقاط نهاية الـ API المتاحة، المبنية حول بنية REST. ستُعيد جميع نقاط نهاية الـ API استجابة JSON مع رموز استجابة HTTP القياسية وتحتاج إلى مصادقة Bearer عبر مفتاح API.

 

المصادقة

جميع نقاط نهاية الـ API تتطلب مفتاح API يُرسل بواسطة طريقة مصادقة Bearer.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://qr8.tech/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "\u0644\u064a\u0633 \u0644\u062f\u064a\u0643 \u0635\u0644\u0627\u062d\u064a\u0629 \u0644\u0644\u0648\u0635\u0648\u0644 \u0625\u0644\u0649 \u0627\u0644\u0640 API.",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
جميع نتائج نقاط نهاية الـ API تعمل مع التوقيت الزمني UTC ما لم يُذكر خلاف ذلك.
المستخدم
الروابط
إحصاءات الروابط
المشروعات
بكسلات
صفحات الانتظار
رموز QR
التواقيع
البيانات
معالجات الإشعارات
النطاقات المخصصة
الفرق
أعضاء الفريق
عضو الفريق
دفعات الحساب
سجلات الحساب