API文档概述

1.获取帐户详细详情

端点: 获取 https://voooc.com/api/account/details

描述: 检索与提供的API密钥关联的帐户的详细信息。

2.获取所有作品

端点: 获取 https://voooc.com/api/items/all

描述: 检索与提供的API键关联的所有项。

3. 获取作品详情

端点: 获取 https://voooc.com/api/items/item

描述: 根据提供的作品ID和API键检索特定作品的详细信息。

4.购买验证

端点: 发布 https://voooc.com/api/purchases/validation

描述: 验证购买代码，如果有效则返回有关购买的详细信息。

认证

导航到工作区设置

用户首先应登录其在平台上的帐户。然后，他们可以导航到其工作区的“设置”部分。

定位API密钥部分

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

生成或检索API密钥

在此部分中，用户可以生成新的API密钥，也可以检索先前生成的现有密钥。如果有生成新密钥的选项，用户可以单击它来创建新的API密钥。

复制API密钥

一旦生成或检索了 API密钥，用户应该能够在屏幕上看到它。他们可以简单地点击密钥旁边的按钮或图标，将其复制到剪贴板中。

使用 API键

在API密钥被复制后，用户现在可以使用它来验证访问平台API端点时的请求。根据AP身份验证机制的不同，他们通常需要在请求头或参数中包含API密钥。

锁定 API密钥

提醒用户保持他们的API密钥安全并且不公开共享它们是至关重要的。他们应该避免在客户端代码中硬编码API密钥，或者在可公开访问的存储库中共享它们。相反，他们应该考虑将API密钥安全地存储在服务器端应用程序上，并使用适当的访问控制。

获取账户详情

检索与提供的API密钥关联的帐户的详细信息

端点

获取
https://voooc.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键关联的所有项目

端点

获取
https://voooc.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": "USD",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

错误响应:

{
    "status": "错误",
    "msg": "未找到作品"
}

获取作品详情

根据提供的作品ID和API键检索特定作品的详细信息。

端点

获取
https://voooc.com/api/items/item

参数

  • api_key: 您的 API密钥 (必填)
  • item_id: 要检索的作品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": "USD",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

错误响应:

{
    "status": "错误",
    "msg": "未找到作品"
}

购买验证

验证购买代码，如果有效则返回有关购买的详细信息。

端点

发布
https://voooc.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",
                "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": "USD",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "supported_until": "2024-04-27T12:00:00Z", // 如果禁用支持或不受支持，则不会出现这种情况
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

错误响应:

{
    "status": "错误",
    "msg": "无效的购买代码"
}