API文档概述

1.获取帐户详细信息

Url: GET https://thousandyards.com/api/account/details

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

2. 查看所有商品

Url: GET https://thousandyards.com/api/items/all

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

3. 获取商品详细

Url: GET https://thousandyards.com/api/items/item

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

4. 购买验证

Url: POST https://thousandyards.com/api/purchases/validation

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

身份验证

导航到“平台设置”

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

找到API关键部分

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

重新生成 API Key

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

复制 API Key

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

使用 API Key

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

获取 API Key

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

获取帐户详细信息

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

Url

GET
https://thousandyards.com/api/account/details

参数设置

  • api_key: 你的API key (必须认证)

响应

响应成功:

{
    "status": "成功",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "john.doe@example.com",
        "balance": 100.00,
        "currency": "SGD",
        "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键关联的所有项

Url

GET
https://thousandyards.com/api/items/all

参数设置

  • api_key: 你的API key (必须认证)

响应

响应成功:

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

错误响应:

{
    "status": "错误",
    "msg": "该分类下暂无商品上架"
}

获取商品详细

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

Url

GET
https://thousandyards.com/api/items/item

参数设置

  • api_key: 你的API key (必须认证)
  • 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": "SGD",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

错误响应:

{
    "status": "错误",
    "msg": "未找到任何商品"
}

购买验证

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

Url

POST
https://thousandyards.com/api/purchases/validation

参数设置

  • api_key: 你的API key (必须认证).
  • purchase_code: 要验证的购买代码 (必须认证).

响应

响应成功:

{
    "status": "成功",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "授权版",
            "price": 19.99,
            "currency": "SGD",
            "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": "购买代码无效"
}