应用程序接口文件概述

1. 获取账户详细信息

Endpoint: GET http://bat1688.com/api/account/details

描述: 读取与提供的 API 密钥关联的账户的详细信息。

2. 获取所有项目

Endpoint: GET http://bat1688.com/api/items/all

描述: 读取与提供的 API 密钥相关的所有项目。

3. 获取项目详情

Endpoint: GET http://bat1688.com/api/items/item

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

4. 采购验证

Endpoint: POST http://bat1688.com/api/purchases/validation

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

认证

导航至工作区设置

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

查找 API 密钥部分

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

生成或检索 API 密钥

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

复制 API 密钥

生成或获取 API 密钥后，用户应能看到屏幕上显示的密钥。用户只需点击密钥旁边的按钮或图标，就能将其复制到剪贴板上。

使用应用程序接口密钥

复制了 API 密钥后，用户就可以在访问平台 API 端点时使用它来验证请求。用户通常需要将 API 密钥作为请求标头或参数的一部分，具体取决于 API 身份验证机制。

保护应用程序接口密钥

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

获取账户详情

读取与提供的 API 密钥关联的账户的详细信息

Endpoint


            GET
http://bat1688.com/api/account/details

参数

api_key: 您的 API 密钥 (Required)

响应

成功响应:


            {
    "status": "success",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "[email protected]",
        "balance": 100.00,
        "currency": "USD",
        "profile": {
            "heading": "Profile Heading",
            "description": "Profile Description",
            "contact": {
                "email": "[email protected]"
            },
            "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
http://bat1688.com/api/items/all

参数

api_key: 您的 API 密钥 (Required)

响应

成功响应:


            {
    "status": "success",
    "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 密钥，读取特定项目的详细信息。

这只对作者有效，对普通用户无效。

Endpoint


            GET
http://bat1688.com/api/items/item

参数

api_key: 您的 API 密钥 (Required)
item_id: 要检索的项目的 ID (Required)

响应

成功响应:


            {
    "status": "success",
    "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": "未找到项目"
}

购买验证

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

这只对作者有效，对普通用户无效。

Endpoint


            POST
http://bat1688.com/api/purchases/validation

参数

api_key: 您的 API 密钥 (Required).
purchase_code: 验证购买代码 (Required).

响应

成功响应:


            {
    "status": "success",
    "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": "无效购买代码"
}