mixiページアプリ » 技術仕様 » Page App API
Page App API
mixiページアプリの開発者や管理者様向けのAPIです。自身のmixiページアプリ情報を取得できます。 Page App APIはPage APIと同じくmixi Graph APIの一部で、mixiページアプリは本APIを利用することができます。
事前に必要なもの
Page APP APIを利用するためには、以下の情報をすでに入手している必要があります。
- クライアント認証されたアクセストークン
上記以外のスコープで認可されたアクセストークンを使用して、Page App APIにアクセスすることはできません。
詳細は、「技術仕様概要」の「アクセストークンの取得(クライアント認証)」 (http://developer.mixi.co.jp/page-apps/spec/summary/#toc-5
)をご覧ください。
Page App APIで提供される機能とアクセストークン
以下に、Page App APIの機能と利用に必要なアクセストークンの対応を示します。
| 機能 | アクセストークン |
|---|---|
| アプリが設置されているページIDの取得 | クライアント認証されたアクセストークン |
アプリが設置されているページIDの取得
本APIへアクセスしているアプリが設置されているページID等を取得します。
GET http://api.mixi-platform.com/2/pageapp/pages
以下のクエリパラメータをサポートします。
| パラメータ名 | 指定する値 |
|---|---|
| pageId | mixiページのID。特定のページのみに絞りたい場合に指定します |
取得結果は、以下のようなJSON形式となります。
<例> 一覧を取得する場合
{
"entry" : [
{
pageId : "100001",
moduleIds : [
"100",
"101",
"102"
]
},
・・・(省略)・・・
]
};
<例> 特定のページを指定した場合
{
"entry" : {
pageId : "100001",
moduleIds : [
"100",
"101",
"102"
]
}
};
個々のエントリに含まれる情報は、以下となります。
| 属性名 | 説明 |
|---|---|
| pageId | mixiページのID |
| moduleId | mixiページ上で複数の同一アプリが配置されていた場合に識別するためのID |
ページング
Page App APIは、ページングをサポートします。
詳細は「ページングの指定方法」(http://developer.mixi.co.jp/connect/mixi_graph_api/mixi_io_spec_top/api_common_spec#toc-1
)をご参照ください。
本APIの、1ページあたりの取得件数(count)のデフォルト値は100件、1ページあたりの取得件数(count)の最大値は1,000件です。