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

1. جزئیات حساب را دریافت کنید

نقطه پایانی: دریافت کنید http://wachar.net/api/account/details

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

2. گرفتن همه ایتمها

نقطه پایانی: دریافت کنید http://wachar.net/api/items/all

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

3. گرفتن جزییات ایتم

نقطه پایانی: دریافت کنید http://wachar.net/api/items/item

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

4. اعتبارسنجی خرید

نقطه پایانی: پست http://wachar.net/api/purchases/validation

توضیحات: کد خرید را اعتبارسنجی کرده و اگر جزییات ان معتبر است تایید کنید.

احراز هویت

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

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

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

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

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

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

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

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

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

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

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

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

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

جزئیات حساب مرتبط با کلید API ارائه شده را بازیابی می کند

نقطه پایانی

دریافت کنید
http://wachar.net/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": "Irr",
        "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 ارائه شده را بازیابی می کند

نقطه پایانی

دریافت کنید
http://wachar.net/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": "Irr",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

پاسخ های خطا:

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

دریافت جزئیات یک آیتم

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

نقطه پایانی

دریافت کنید
http://wachar.net/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": "Irr",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

پاسخ های خطا:

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

اعتبار خرید

کد خرید را اعتبارسنجی کرده و اگر جزییات ان معتبر است تایید کنید.

نقطه پایانی

پست
http://wachar.net/api/purchases/validation

پارامترها

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

پاسخا

پاسخهای موفق:

{
    "status": "موفق",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "معمولی",
            "price": 19.99,
            "currency": "Irr",
            "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": "کد خرید نامعتبر است"
}