記事一覧の取得

このインターフェースは、複数の記事情報を一度に取得するために使用されます。

リクエストメソッド

GET /api/v1/articles

リクエストパラメータ

なし

レスポンス結果

属性名	型	説明
status	整数	実行結果コード、0は成功を表します
message	文字列	実行結果の説明
size	整数	データ総数（廃止）
total	整数	データ総数
contents	配列	記事の配列。詳細はヘルプセンターデータ-記事を参照してください。content情報は含まれません。

例

curl https://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 https://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>"
    }
}

---

記事カテゴリリストの取得

このAPIは全ての記事カテゴリ情報を取得するために使用されます

リクエストメソッド

GET /api/v1/categories

リクエストパラメータ

なし

返却結果

属性名	型	説明
status	整数	実行結果コード、0は成功を表す
message	文字列	実行結果の説明
total	整数	データ総数
contents	配列	カテゴリ配列、詳細はヘルプセンターデータ-カテゴリ を参照、sections情報は含まれません

例

curl https://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 https://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 https://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 https://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 https://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	否	1ページあたりの件数。デフォルトは20

レスポンス結果

属性名	型	説明
status	整数	実行結果コード。0は成功を表します
message	文字列	実行結果の説明
size	整数	今回返却された件数
total	整数	データ総数
contents	配列	問題の配列。詳細はヘルプセンター データ - 問題を参照してください

注意：戻り値のcontentsには、content、answersなどのパラメータは含まれません。

例

curl https://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 https://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"
            }
        ]
    }
}

---

記事を検索

このAPIは、キーワードに関連する記事のリストを取得するために使用されます。

リクエストメソッド

GET /api/v1/articles/search

リクエストパラメータ（Query String）

パラメータ名	必須	説明
q	はい	キーワード
page	いいえ	ページ番号、1から開始、デフォルトは1
per_page	いいえ	1ページあたりの件数、デフォルト20、最大100

レスポンス結果

記事リスト取得APIと同じです

サンプル

curl https://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	いいえ	1ページあたりの件数、デフォルト20、最大100

返却結果

問題リスト取得インターフェースと同じです。

例

curl https://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	整数型	ユニークID
subject	文字列	タイトル
section_id	整数型	セクションID
section	文字列	セクション名
category_id	整数型	カテゴリーID
category	文字列	カテゴリー名
created_at	日時	作成日時
updated_at	日時	更新日時
content	文字列	内容

質問

属性名	型	説明
id	整数型	ユニークID
subject	文字列	タイトル
author	文字列	質問者ニックネーム
topic_id	整数型	質問カテゴリーID
topic	文字列	質問カテゴリー名
created_at	日時	作成日時
updated_at	日時	更新日時
content	文字列	内容
answers	配列	回答リスト

answers要素の構造

属性名	型	説明
content	文字列	内容
answer_id	整数型	ユニークID
is_official	ブール型	公式回答かどうか
author	文字列	回答者ニックネーム
created_at	日時	作成日時
updated_at	日時	更新日時

---

statusエラーコード説明

エラーコード	message情報	説明
1001	指定されたIDが存在しません	パラメータ{id}に一致するデータが見つかりません
	指定されたカテゴリーIDが存在しません	パラメータ{id}に一致する”カテゴリー“データが見つかりません
	指定されたセクションIDが存在しません	パラメータ{id}に一致する”セクション“データが見つかりません
2002	署名エラー、バージョンをアップグレードしてご利用ください!	パラメータ{sign}が誤っており、認証に失敗しました

errorエラー説明

error情報	説明
q is missing	必須パラメータ{q}が入力されていません
per_page should be between 1 and 100	パラメータ{per_page}が有効範囲外です