توثيق واجهة برمجة التطبيقات (API)

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

 
احصل على مفتاح API الخاص بك

المصادقة

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

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

الأخطاء

تستخدم واجهة API الخاصة بنا رموز حالة HTTP المتعارف عليها للإشارة إلى نجاح الطلب أو فشله.

{
    "errors": [
        {
            "title": "\u0644\u064a\u0633\u062a \u0644\u062f\u064a\u0643 \u0635\u0644\u0627\u062d\u064a\u0629 \u0627\u0644\u0648\u0635\u0648\u0644 \u0625\u0644\u0649 \u0648\u0627\u062c\u0647\u0629 \u0628\u0631\u0645\u062c\u0629 \u0627\u0644\u062a\u0637\u0628\u064a\u0642\u0627\u062a (API).",
            "status": 401
        }
    ]
}
200 تم تنفيذ الطلب بنجاح
400 طلب غير صالح - المعاملات المطلوبة مفقودة أو غير صالحة
401 غير مصرّح - مفتاح API مفقود أو غير صالح
404 لم يتم العثور على المورد المطلوب
429 طلبات كثيرة جدًا - تم تجاوز الحد المسموح لعدد الطلبات
500 خطأ داخلي في الخادم - يعني ذلك وجود مشكلة من جهتنا
تعمل جميع نتائج نقاط نهاية الـ API مع منطقة زمنية UTC ما لم يُذكر خلاف ذلك.
المستخدم
الروابط
إحصائيات الروابط
المشاريع
بكسلات
رموز الاستجابة السريعة (QR)
البيانات
معالجات الإشعارات
النطاقات المخصصة
مدفوعات الحساب
سجلات الحساب