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

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

Endpoint: GET https://etqancode.net/api/account/details

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

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

Endpoint: GET https://etqancode.net/api/items/all

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

3. احصل على تفاصيل المنتج

Endpoint: GET https://etqancode.net/api/items/item

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

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

Endpoint: POST https://etqancode.net/api/purchases/validation

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

Authentication

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

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

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

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

توليد أو استرداد مفتاح API

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

انسخ مفتاح API

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

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

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

تأمين مفتاح API

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

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

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

Endpoint

GET
https://etqancode.net/api/account/details

Parameters

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

Responses

Success Response:

{
    "status": "success",
    "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"
    }
}

Error Response:

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

احصل على جميع العناصر

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

Endpoint

GET
https://etqancode.net/api/items/all

Parameters

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

Responses

Success Response:

{
    "status": "success",
    "items": [
        {
            "id": 1,
            "name": "Sample Item",
            "description": "This is a sample item",
            "category": "Category Name",
            "sub_category": "Subcategory Name",
            "options": ["option1", "option2"],
            "demo_link": "https://example.com/demo",
            "tags": ["tag1", "tag2"],
            "media": {
                "preview_image": "https://example.com/preview.jpg",
                "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...
        }
    ]
}

Error Response:

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

احصل على تفاصيل المنتج

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

Endpoint

GET
https://etqancode.net/api/items/item

Parameters

  • api_key: مفتاح API الخاص بك (مطلوب)
  • item_id: The ID of the item to retrieve (مطلوب)

Responses

Success Response:

{
    "status": "success",
    "item": {
        "id": 1,
        "name": "Sample Item",
        "description": "This is a sample item",
        "category": "Category Name",
        "sub_category": "Subcategory Name",
        "options": ["option1", "option2"],
        "demo_link": "https://example.com/demo",
        "tags": ["tag1", "tag2"],
        "media": {
            "preview_image": "https://example.com/preview.jpg",
            "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"
    }
}

Error Response:

{
    "status": "error",
    "msg": "Item Not Found"
}

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

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

Endpoint

POST
https://etqancode.net/api/purchases/validation

Parameters

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

Responses

Success Response:

{
    "status": "success",
    "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"
                }
            },
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Error Response:

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