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

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

Endpoint: GET https://klzaa.com/api/account/details

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

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

Endpoint: GET https://klzaa.com/api/items/all

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

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

Endpoint: GET https://klzaa.com/api/items/item

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

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

Endpoint: POST https://klzaa.com/api/purchases/validation

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

المصادقة

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

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

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

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

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

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

نسخ مفتاح API

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

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

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

تأمين مفتاح API

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

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

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

Endpoint

GET
https://klzaa.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 المقدم.

Endpoint

GET
https://klzaa.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", // This is not included for audio items
                "preview_video": "https://example.com/video.mp4", // This is only included for video items
                "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
                "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 المقدم.

Endpoint

GET
https://klzaa.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", // This is not included for audio items
            "preview_video": "https://example.com/video.mp4", // This is only included for video items
            "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
            "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": "العنصر غير موجود"
}

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

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

Endpoint

POST
https://klzaa.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", // This will not exist if support is disabled or its not supported
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

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

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