印刷する

カテゴリー

categories > get

カテゴリー情報をリクエストします。

リクエストの構築

リクエストURLとGET変数

リクエスト固有のGET変数

変数値説明
gocategoriesAPIセクション
dogetAPIアクション
iqCategory IDカテゴリーID

リクエストURLは以下のようになります。必須情報(key, timestamp, salt, signature)を追加することを忘れないでください。

https://....../api.php?go=categories&do=get&iq={category_id}&{required information}
POST変数

このリクエストにはPOST変数は必要ありません。

応答例

リクエストが成功した場合は、以下の内容のレスポンスを受け取ります。
・data：カテゴリー情報。配列"breadcrumb"と"children"も戻り値に含まれています。

{
    "data": {
        "banner_mobile": "",
        "banner_player": "",
        "banner_sidebar": "",
        "banner_top": "",
        "breadcrumb": [1],
        "children": [6, 7, 18],
        "description": "The latest movies",
        "description_seo": "The latest movies",
        "id": "1",
        "id_parent": "",
        "img_bkg": "",
        "img_bkg_attachment": "scroll",
        "img_bkg_color": "#FF59D8",
        "img_bkg_position_x": "center",
        "img_bkg_position_y": "top",
        "img_bkg_repeat": "repeat",
        "img_bkg_use": "1",
        "img_icon": "http:\/\/......\/uploads\/images\/category_1_1364385555_icon.jpg",
        "img_poster": "http:\/\/......\/uploads\/images\/category_1_1364385555_poster.jpg",
        "img_social": "http:\/\/......\/uploads\/images\/category_1_1364385555_social.jpg",
        "img_thumbnail": "http:\/\/......\/uploads\/images\/category_1_1364385555_thumb.jpg",
        "order": "0",
        "page_endbody_code": "",
        "page_head_code": "",
        "status": "1",
        "tags": "movies, trailers, teasers",
        "title": "Movies",
        "title_url": "movies",
        "title_url_full": "movies",
        "url": "http:\/\/......\/index.php\/c\/1\/movies\/",
        "views_page": "2557"
    }
}

認証情報にGETの許可がない場合など、リクエストが失敗した場合のレスポンス

{
	"error"		 : "REQUEST_ERROR",
	"error_long" : "Permission error: GET"
}

このリクエストは以下のエラーを返す可能性があります。

・REQUEST_ERROR | Invalid Category ID
カテゴリーIDが1未満かもしくは数値ではありません。

・REQUEST_ERROR | Category not found or inactive
カテゴリーが見つからない、もしくは非アクティブです。

その他のエラー内容に関しては一般的なエラーメッセージを確認してください。

PHPサンプルコード

GETおよびPOSTデータを準備します。

// GET変数
$GET_VARS = array( 
					"go"        => "categories",
					"do"        => "get",
					"iq"        => 1
					);

// POST変数
$POST_VARS = array();