帮助中心接口

获取文章列表

该接口用于一次获取多个文章信息

请求方法

GET /api/v1/articles

请求参数

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
size 整型 数据总数(废弃)
total 整型 数据总数
contents 数组 文章数组,详见帮助中心数据

示例

curl http://demo.udesk.cn/api/v1/articles?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 2,
    "total": 2,
    "contents": [
        {
            "id": 1,
            "subject": "测试文章1",
            "section_id": 1,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        },
        {
            "id": 2,
            "subject": "测试文章2",
            "section_id": 2,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        }
    ]
}

获取文章详情

该接口用于获取指定id的文章信息

请求方法

GET /api/v1/articles/:id

请求参数(URL中)

参数名 必填 说明
id 文章id

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
size 整型 数据总数(废弃)
total 整型 数据总数
contents 对象 文章信息,详见帮助中心数据

示例

curl http://demo.udesk.cn/api/v1/articles/1?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 1,
    "total": 1,
    "contents": {
        "id": 1,
        "subject": "测试文章1",
        "section_id": 1,
        "section": "章节1",
        "category_id": 1,
        "category": "文章分类1",
        "created_at": "2015-01-01 12:00:00 +0800",
        "updated_at": "2015-01-01 12:00:00 +0800",
        "content": "<p>文章内容通常为富文本</p>"
    }
}

获取文章类别列表

该接口用于获取全部文章类别信息

请求方法

GET /api/v1/categories

请求参数

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
total 整型 数据总数
contents 数组 类别数组,详见帮助中心数据,不包含sections信息

示例

curl http://demo.udesk.cn/api/v1/categories?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "total": 2,
    "contents": [
        {
            "id": 1,
            "name": "文章分类1",
            "describe": "一般",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800",
            "sequence": 0
        },
        {
            "id": 2,
            "name": "文章分类2",
            "describe": "消费类问题汇总",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800",
            "sequence": 1
        }
    ]
}

获取文章类别详情

该接口用于获取指定类别的详细信息,包含章节列表

请求方法

GET /api/v1/categories/:id

请求参数(URL中)

参数名 必填 说明
id 类别id

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
total 整型 数据总数
contents 对象 文章类别详情,详见帮助中心数据

示例

curl http://demo.udesk.cn/api/v1/categories/1?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "total": 3,
    "contents": {
        "id": 1,
        "name": "文章分类1",
        "describe": "一般",
        "created_at": "2015-01-01 12:00:00 +0800",
        "updated_at": "2015-01-01 12:00:00 +0800",
        "sequence": 0,
        "sections": [
            {
                "id": 1,
                "subject": "章节1",
                "describe": "测试章节",
                "created_at": "2015-01-01 12:00:00 +0800",
                "updated_at": "2015-01-01 12:00:00 +0800",
                "sequence": 0
            },
            {
                "id": 2,
                "subject": "章节2",
                "describe": "测试章节",
                "created_at": "2015-01-01 12:00:00 +0800",
                "updated_at": "2015-01-01 12:00:00 +0800",
                "sequence": 0
            },
            {
                "id": 3,
                "subject": "章节3",
                "describe": "测试章节",
                "created_at": "2015-01-01 12:00:00 +0800",
                "updated_at": "2015-01-01 12:00:00 +0800",
                "sequence": 0
            }
        ]
    }
}


获取指定类别的文章列表

该接口用于获取指定类别的文章信息

请求方法

GET /api/v1/categories/:id/articles

请求参数(URL中)

参数名 类型 说明
id 整型 类别id

返回结果

与[获取文章列表接口][]相同。

示例

curl http://demo.udesk.cn/api/v1/categories/1/articles?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 2,
    "total": 2,
    "contents": [
        {
            "id": 1,
            "subject": "测试文章1",
            "section_id": 1,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        },
        {
            "id": 2,
            "subject": "测试文章2",
            "section_id": 2,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        }
    ]
}

获取章节列表

该接口用于获取全部章节信息

请求方法

GET /api/v1/sections

请求参数

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
total 整型 数据总数
contents 数组 章节数组,详见帮助中心数据

示例

curl http://demo.udesk.cn/api/v1/sections?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "total": 3,
    "contents": [
        {
            "id": 1,
            "subject": "章节1",
            "describe": "测试章节",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800",
            "sequence": 0
        },
        {
            "id": 2,
            "subject": "章节2",
            "describe": "测试章节",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800",
            "sequence": 0
        },
        {
            "id": 3,
            "subject": "章节3",
            "describe": "测试章节",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800",
            "sequence": 0
        }
    ]
}

获取指定章节的文章列表

该接口用于获取指定章节的文章信息

请求方法

GET /api/v1/sections/:id/articles

请求参数(URL中)

参数名 类型 说明
id 整型 章节id

返回结果

与[获取文章列表接口][]相同。

示例

curl http://demo.udesk.cn/api/v1/sections/1/articles?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 2,
    "total": 2,
    "contents": [
        {
            "id": 1,
            "subject": "测试文章1",
            "section_id": 1,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        },
        {
            "id": 2,
            "subject": "测试文章2",
            "section_id": 2,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        }
    ]
}

获取问题列表

该接口用于一次获取多个问题信息

请求方法

GET /api/v1/questions

请求参数(Query String)

参数名 必填 说明
page 页码,从1开始,默认为1
per_page 每页数量,默认20

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
size 整型 本次返回数量
total 整型 数据总数
contents 数组 问题数组,详见帮助中心数据

示例

curl http://demo.udesk.cn/api/v1/questions?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 1,
    "total": 1,
    "contents": [
        {
            "id": 1,
            "subject": "测试问题",
            "author": "测试客户",
            "topic_id": 1,
            "topic": "测试主题",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        }
    ]
}

获取问题详情

该接口用于获取指定id的问题信息

请求方法

GET /api/v1/questions/:id

请求参数(URL中)

参数名 类型 说明
id 整型 问题id

返回结果

属性名 类型 说明
status 整型 执行结果码,0代表成功
message 字符串 执行结果说明
size 整型 数据总数(废弃)
total 整型 数据总数
contents 对象 问题信息,详见帮助中心数据

示例

curl http://demo.udesk.cn/api/v1/questions/1?sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 1,
    "total": 1,
    "contents": {
        "id": 1,
        "subject": "测试问题",
        "author": "测试客户",
        "topic_id": 1,
        "topic": "测试主题",
        "created_at": "2015-01-01 12:00:00 +0800",
        "updated_at": "2015-01-01 12:00:00 +0800",
        "content": "<p>问题内容通常都是富文本</p>",
        "answers": [
            {
                "content": "<p>答案内容通常都是富文本</p>",
                "answer_id": 1,
                "is_official": false,
                "author": "测试客服",
                "created_at": "2015-01-01 12:00:00 +0800",
                "updated_at": "2015-01-01 12:00:00 +0800"
            }
        ]
    }
}

搜索文章

该接口用于获取与关键字相关的文章列表

请求方法

GET /api/v1/articles/search

请求参数(Query String)

参数名 必填 说明
q 关键字
page 页码,从1开始,默认为1
per_page 每页数量,默认20,最大100

返回结果

与[获取文章列表接口][]相同。

示例

curl http://demo.udesk.cn/api/v1/articles/search?q=测试&page=1&per_page=10&sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 2,
    "total": 2,
    "contents": [
        {
            "id": 1,
            "subject": "测试文章1",
            "section_id": 1,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        },
        {
            "id": 2,
            "subject": "测试文章2",
            "section_id": 2,
            "section": "章节1",
            "category_id": 1,
            "category": "文章分类1",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        }
    ]
}

搜索问题

该接口用于获取与关键字相关的问题列表

请求方法

GET /api/v1/questions/search

请求参数(Query String)

参数名 必填 说明
q 关键字
page 页码,从1开始,默认为1
per_page 每页数量,默认20,最大100

返回结果

与[获取问题列表接口][]相同。

示例

curl http://demo.udesk.cn/api/v1/questions/search?q=测试&page=1&per_page=10&sign=129da7df812jdfsa9912jfdadf81

返回

{
    "status": 0,
    "message": "成功",
    "size": 1,
    "total": 1,
    "contents": [
        {
            "id": 1,
            "subject": "测试问题",
            "author": "测试客户",
            "topic_id": 1,
            "topic": "测试主题",
            "created_at": "2015-01-01 12:00:00 +0800",
            "updated_at": "2015-01-01 12:00:00 +0800"
        }
    ]
}

数据结构-帮助中心

类别

属性名 类型 说明
id 整型 唯一标识
name 字符串 类别名称
describe 字符串 类别描述
created_at 日期时间 创建时间
updated_at 日期时间 更新时间
sequence 整型 排序序号
sections 数组 章节列表,元素的结构见“章节”

章节

属性名 类型 说明
id 整型 唯一标识
subject 字符串 名称
describe 字符串 描述
created_at 日期时间 创建时间
updated_at 日期时间 更新时间
sequence 整型 排序序号

文章

属性名 类型 说明
id 整型 唯一标识
subject 字符串 标题
section_id 整型 章节id
section 字符串 章节名称
category_id 整型 类别id
category 字符串 类别名称
created_at 日期时间 创建时间
updated_at 日期时间 更新时间
content 字符串 内容

问题

属性名 类型 说明
id 整型 唯一标识
subject 字符串 标题
author 字符串 提问者昵称
topic_id 整型 问题分类id
topic 字符串 问题分类名称
created_at 日期时间 创建时间
updated_at 日期时间 更新时间
content 字符串 内容
answers 数组 答案列表

answers元素的结构

属性名 类型 说明
content 字符串 内容
answer_id 整型 唯一标识
is_official 布尔 是否是官方回答
author 字符串 回答者昵称
created_at 日期时间 创建时间
updated_at 日期时间 更新时间