نظرة عامة على وثائق واجهة برمجة التطبيقات

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

نقطة النهاية: يحصل https://sellcod.com/api/account/details

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

2. الحصول على جميع العناصر

نقطة النهاية: يحصل https://sellcod.com/api/items/all

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

3. الحصول على تفاصيل العنصر

نقطة النهاية: يحصل https://sellcod.com/api/items/item

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

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

نقطة النهاية: بريد https://sellcod.com/api/purchases/validation

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

المصادقة

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

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

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

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

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

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

نسخ مفتاح API

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

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

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

تأمين مفتاح API

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

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

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

نقطة النهاية

يحصل
https://sellcod.com/api/account/details

حدود

  • 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": "USD",
        "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://sellcod.com/api/items/all

حدود

  • 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": "USD",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

استجابة الخطأ:

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

احصل على تفاصيل العنصر

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

نقطة النهاية

يحصل
https://sellcod.com/api/items/item

حدود

  • 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": "USD",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

استجابة الخطأ:

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

نقطة النهاية

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

نقطة النهاية

بريد
https://sellcod.com/api/purchases/validation

حدود

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

الاستجابات

استجابة النجاح:

{
    "status": "نجاح",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "عادي",
            "price": 19.99,
            "currency": "USD",
            "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": "رمز الشراء غير صالح"
}