مرور کلی مستندات API

۱- دریافت اطلاعات حساب

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

توضیحات: اطلاعات حساب مرتبط با کلید API ارایه شده را بازمی‌گرداند.

۲- دریافت تمام محصولات

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

توضیحات: تمام محصولات مرتبط به کلید API ارایه شده را بازمی‌گرداند.

۳- دریافت اطلاعات محصول

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

توضیحات: جزئیات یک محصول خاص را بر اساس شناسه محصول ارائه شده و کلید API بازیابی می کند.

۴- تایید اعتبار خرید

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

توضیحات: یک کد خرید را اعتبارسنجی کنید تا در صورت تایید اعتبار، اطلاعاتی درباره خرید بازگردانده شود.

احراز هویت

به تنظیمات محیط کار بروید

کاربر ابتدا باید به حساب کاربری خود در پلتفرم وارد شود. سپس می‌تواند به بخش "تنظیمات" در محیط کار خود برود.

بخش کلید API را پیدا کنید

در تنظیمات فضای کاری، کاربر باید به دنبال بخشی با برچسب "API Key" یا "API Access" باشد.

کلید API را ایجاد یا بازیابی کنید

در این بخش، کاربر می تواند یک کلید API جدید ایجاد کند یا یک کلید موجود را در صورتی که قبلا تولید شده است، بازیابی کند. اگر گزینه ای برای ایجاد یک کلید جدید وجود دارد، کاربر می تواند روی آن کلیک کند تا یک کلید API جدید ایجاد کند.

کلید API را کپی کنید

هنگامی که کلید API تولید یا بازیابی شد، کاربر باید بتواند آن را روی صفحه نمایش ببیند. آنها به سادگی می توانند روی یک دکمه یا آیکون کنار کلید کلیک کنند تا آن را در کلیپ بورد خود کپی کنند.

استفاده از کلید API

با کپی شدن کلید API، کاربر اکنون می تواند از آن برای احراز هویت درخواست های خود هنگام دسترسی به نقاط پایانی API پلتفرم کدافزار استفاده کند. بسته به مکانیزم احراز هویت API، معمولاً باید کلید API را به عنوان بخشی از سرصفحه ها یا پارامترهای درخواست درج کنند.

کلید API را امن نگهدارید

ضروری است به کاربران یادآوری کنیم که کلیدهای API خود را ایمن نگه دارند و آنها را به صورت عمومی به اشتراک نگذارند. آنها باید از کدگذاری کلیدهای API در کد سمت سرویس گیرنده یا اشتراک گذاری آنها در مخازن در دسترس عموم اجتناب کنند. در عوض، آن‌ها باید کلید API را به‌طور امن در برنامه‌های سمت سرور خود ذخیره کنند و از کنترل‌های دسترسی مناسب استفاده کنند.

دریافت جزییات حساب

Retrieves details of the account associated with the provided API key

Endpoint

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

پاسخ خطا:

{
    "status": "خطا",
    "msg": "محصولی یافت نشد"
}

دریافت جزییات یک محصول

جزئیات یک محصول خاص را بر اساس شناسه محصول ارائه شده و کلید API بازیابی می کند.

Endpoint

GET
https://codeafzar.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": "IRT",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

پاسخ خطا:

{
    "status": "خطا",
    "msg": "محصول پیدا نشد"
}

تایید اعتبار خرید

یک کد خرید را اعتبارسنجی کنید تا در صورت تایید اعتبار، اطلاعاتی درباره خرید بازگردانده شود.

Endpoint

POST
https://codeafzar.com/api/purchases/validation

پارامترها

  • api_key: کلید API شما (الزامی).
  • purchase_code: کد خرید برای اعتبارسنجی (الزامی).

پاسخ‌ها

پاسخ موفقیت‌آمیز:

{
    "status": "موفقیت‌آمیز",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "معمولی",
            "price": 19.99,
            "currency": "IRT",
            "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": "IRT",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "supported_until": "2024-04-27T12:00:00Z", // این گزینه وجود نخواهد داشت اگر آیتم پشتیبانی نشده باشد یا پشتیبانی غیرفعال باشد
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

پاسخ خطا:

{
    "status": "خطا",
    "msg": "کد خرید نامعتبر است"
}