نظرة عامة على وثائق API

1. الحصول على تفاصيل الحساب

نقطة النهاية: الحصول https://store.cit.com.sa/api/account/details

الوصف: يسترجع تفاصيل الحساب المرتبط بمفتاح API المقدم.

2. الحصول على جميع الخدمات

نقطة النهاية: الحصول https://store.cit.com.sa/api/items/all

الوصف: يسترجع جميع الخدمات المرتبطة بمفتاح API المقدم.

3. الحصول على تفاصيل الخدمة

نقطة النهاية: الحصول https://store.cit.com.sa/api/items/item

الوصف: يسترجع تفاصيل الخدمة محدد بناءً على معرف الخدمة ومفتاح API المقدمين.

4. التحقق من الشراء

نقطة النهاية: إرسال https://store.cit.com.sa/api/purchases/validation

الوصف: التحقق من صحة رمز الشراء وإرجاع تفاصيل عن الشراء إذا كان صالحاً.

المصادقة

انتقل إلى إعدادات مساحة العمل

يجب على المستخدم أولاً تسجيل الدخول إلى حسابه على المنصة. ثم يمكنه الانتقال إلى قسم "الإعدادات" في مساحة عمله.

حدد قسم مفتاح API

ضمن إعدادات مساحة العمل، يجب على المستخدم البحث عن قسم مُعنون تحديداً بـ "مفتاح API" أو "الوصول إلى API".

إنشاء أو استرجاع مفتاح API

في هذا القسم، يمكن للمستخدم إما إنشاء مفتاح API جديد أو استرجاع مفتاح موجود إذا تم إنشاؤه مسبقاً. إذا كان هناك خيار لإنشاء مفتاح جديد، يمكن للمستخدم النقر عليه لإنشاء مفتاح API جديد.

نسخ مفتاح API

بمجرد إنشاء مفتاح API أو استرجاعه، يجب أن يتمكن المستخدم من رؤيته معروضاً على الشاشة. يمكنهم ببساطة النقر على زر أو أيقونة بجوار المفتاح لنسخه إلى الحافظة.

استخدام مفتاح API

بعد نسخ مفتاح API، يمكن للمستخدم الآن استخدامه للمصادقة على طلباته عند الوصول إلى نقاط نهاية API للمنصة. عادةً ما يحتاجون إلى تضمين مفتاح API كجزء من رؤوس الطلب أو المعلمات، اعتماداً على آلية مصادقة API.

تأمين مفتاح API

من الضروري تذكير المستخدمين بالحفاظ على أمان مفاتيح API الخاصة بهم وعدم مشاركتها علناً. يجب عليهم تجنب تضمين مفاتيح API في شفرة جانب العميل أو مشاركتها في مستودعات يمكن الوصول إليها علناً. بدلاً من ذلك، يجب عليهم التفكير في تخزين مفتاح API بشكل آمن في تطبيقات جانب الخادم واستخدام ضوابط الوصول المناسبة.

الحصول على تفاصيل الحساب

يسترجع تفاصيل الحساب المرتبط بمفتاح API المقدم

نقطة النهاية

الحصول
https://store.cit.com.sa/api/account/details

Parameters

  • api_key: مفتاح API الخاص بك (مطلوب)

الردود

رد النجاح:

{
    "status": "نجاح",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "john.doe@example.com",
        "balance": 100.00,
        "currency": "SR",
        "profile": {
            "heading": "Profile Heading",
            "description": "Profile Description",
            "contact": {
                "email": "contact@example.com"
            },
            "social_links": [
                "facebook": "/",
                "x": "/",
                // etc...
            ],
            "media": {
                "avatar": "https://example.com/avatar.jpg",
                "cover": "https://example.com/cover.jpg"
            }
        },
        "registered_at": "2024-04-27T12:00:00Z"
    }
}

رد الخطأ:

{
    "status": "خطأ",
    "msg": "طلب غير صالح"
}

الحصول على جميع الخدمات

يسترجع جميع الخدمات المرتبطة بمفتاح API المقدم

نقطة النهاية

الحصول
https://store.cit.com.sa/api/items/all

Parameters

  • api_key: مفتاح API الخاص بك (مطلوب)

الردود

رد النجاح:

{
    "status": "نجاح",
    "items": [
        {
            "id": 1,
            "name": "Sample Item",
            "description": "This is a sample item",
            "category": "Category Name",
            "sub_category": "Subcategory Name",
            "options": ["option1", "option2"],
            "version": 1.0.0,
            "demo_link": "https://example.com/demo",
            "tags": ["tag1", "tag2"],
            "media": {
                "thumbnail": "https://example.com/thumbnail.png",
                "preview_image": "https://example.com/preview.jpg", // هذا غير مشمول للعناصر الصوتية
                "preview_video": "https://example.com/video.mp4", // هذا مشمول فقط للعناصر المرئية
                "preview_audio": "https://example.com/audio.mp3", // هذا مشمول فقط للعناصر الصوتية
                "screenshots": [
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "SR",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

رد الخطأ:

{
    "status": "خطأ",
    "msg": "لم يتم العثور على أي عناصر !"
}

الحصول على تفاصيل الخدمة

يسترجع تفاصيل الخدمة محدد بناءً على معرف الخدمة ومفتاح API المقدمين.

نقطة النهاية

الحصول
https://store.cit.com.sa/api/items/item

Parameters

  • api_key: مفتاح API الخاص بك (مطلوب)
  • item_id: معرف الخدمة المراد استرجاعه (مطلوب)

الردود

رد النجاح:

{
    "status": "نجاح",
    "item": {
        "id": 1,
        "name": "Sample Item",
        "description": "This is a sample item",
        "category": "Category Name",
        "sub_category": "Subcategory Name",
        "options": ["option1", "option2"],
        "version": 1.0.0,
        "demo_link": "https://example.com/demo",
        "tags": ["tag1", "tag2"],
        "media": {
            "thumbnail": "https://example.com/thumbnail.png",
            "preview_image": "https://example.com/preview.jpg", // هذا غير مشمول للعناصر الصوتية
            "preview_video": "https://example.com/video.mp4", // هذا مشمول فقط للعناصر المرئية
            "preview_audio": "https://example.com/audio.mp3", // هذا مشمول فقط للعناصر الصوتية
            "screenshots": [
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "SR",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

رد الخطأ:

{
    "status": "خطأ",
    "msg": "الخدمة غير موجودة !"
}

التحقق من الشراء

التحقق من صحة رمز الشراء وإرجاع تفاصيل عن الشراء إذا كان صالحاً.

نقطة النهاية

إرسال
https://store.cit.com.sa/api/purchases/validation

Parameters

  • api_key: مفتاح API الخاص بك (مطلوب).
  • purchase_code: رمز الشراء المراد التحقق منه (مطلوب).

الردود

رد النجاح:

{
    "status": "نجاح",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "أساسي",
            "price": 19.99,
            "currency": "SR",
            "item": {
                "id": 1,
                "name": "Sample Item",
                "url": "https://example.com/item",
                "media": {
                    "preview_image": "https://example.com/preview.jpg"
                }
            },
            "supported_until": "2024-04-27T12:00:00Z", // هذا لن يكون موجوداً إذا تم تعطيل الدعم أو كان غير مدعوم
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

رد الخطأ:

{
    "status": "خطأ",
    "msg": "رمز شراء غير صالح"
}