API Documentation Overview

1. Get Account Details

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

الوصف: Retrieves details of the account associated with the provided API key.

2. Get All Items

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

الوصف: Retrieves all items associated with the provided API key.

3. Get An Item Details

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

الوصف: Retrieves details of a specific item based on the provided item ID and API key.

4. Purchase Validation

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

الوصف: Validate a purchase code and returns details about the purchase if valid.

المصادقة

Navigate to Workspace Settings

The user should first log in to their account on the platform. Then, they can navigate to the "Settings" section of their workspace.

Locate API Key Section

Within the workspace settings, the user should look for a section specifically labeled "API Key" or "API Access."

Generate or Retrieve API Key

In this section, the user can either generate a new API key or retrieve an existing one if it has been previously generated. If there is an option to generate a new key, the user can click on it to create a fresh API key.

Copy the API Key

Once the API key is generated or retrieved, the user should be able to see it displayed on the screen. They can simply click on a button or icon next to the key to copy it to their clipboard.

Use the API Key

With the API key copied, the user can now use it to authenticate their requests when accessing the platform API endpoints. They typically need to include the API key as part of the request headers or parameters, depending on the API authentication mechanism.

Secure the API Key

Its essential to remind users to keep their API keys secure and not share them publicly. They should avoid hardcoding API keys in client-side code or sharing them in publicly accessible repositories. Instead, they should consider storing the API key securely on their server-side applications and using appropriate access controls.

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

Retrieves details of the account associated with the provided API key

Endpoint

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

Parameters

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

Responses

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

{
    "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": "طلب غير ناجح"
}

الحصول على كل المنتجات

Retrieves all items associated with the provided API key

Endpoint

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

Parameters

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

Responses

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

{
    "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": [ // This is only included if item has 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": "لا يوجد أى منتجات"
}

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

Retrieves details of a specific item based on the provided item ID and API key.

Endpoint

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

Parameters

  • api_key: مفتاح API الخاص بك (مطلوب)
  • item_id: معرف المنتج المراد إسترداده (مطلوب)

Responses

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

{
    "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": [ // This is only included if item has 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": "المنتج غير موجود"
}

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

Validate a purchase code and returns details about the purchase if valid.

Endpoint

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

Parameters

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

Responses

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

{
    "status": "تم بنجاح",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "رخصة عادية",
            "price": 19.99,
            "currency": "USD",
            "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": [ This is only included if item has 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"
            },
            "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": "كود الشراء غير صحيح"
}