API 文档概览

1. 获取账户详情

终端: 获取 https://code.bahew.com/api/account/details

描述: 检索与提供的 API 密钥关联的账户详情。

2. 获取所有项目

终端: 获取 https://code.bahew.com/api/items/all

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

3. 获取项目详情

终端: 获取 https://code.bahew.com/api/items/item

描述: 根据提供的项目 ID 和 API 密钥，检索特定项目的详细信息。

4. 购买验证

终端: POST https://code.bahew.com/api/purchases/validation

描述: 验证购买代码，并在有效时返回有关购买的详细信息。

认证

导航到工作区设置

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

定位 API 密钥部分

在工作区设置中，用户应查找一个专门标记为“API 密钥”或“API 访问”的部分。

生成或检索 API 密钥

在此部分，用户可以生成新的 API 密钥，或者检索之前生成的现有密钥。如果有生成新密钥的选项，用户可以点击它来创建一个新的 API 密钥。

复制 API 密钥

一旦生成或检索到 API 密钥，用户应该能看到它显示在屏幕上。用户只需点击密钥旁边的按钮或图标，就可以将其复制到剪贴板。

使用 API 密钥

复制了 API 密钥后，用户现在可以使用它来认证他们的请求，访问平台的 API 端点。用户通常需要将 API 密钥作为请求头或参数的一部分包含在内，这取决于 API 认证机制。

保护 API 密钥

必须提醒用户保护其 API 密钥，不要公开共享。用户应避免在客户端代码中硬编码 API 密钥或将其共享到公开的仓库中。相反，他们应考虑将 API 密钥安全地存储在服务器端应用程序中，并使用适当的访问控制。

获取账户详情

检索与提供的API密钥相关的账户详情

终端

获取
https://code.bahew.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://code.bahew.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://code.bahew.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": "项目未找到"
}

购买验证

验证购买代码，并在有效时返回有关购买的详细信息。

终端

POST
https://code.bahew.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": "无效的购买代码"
}