PowerCMS ブログ

2014年07月24日

PowerCMSオブジェクトのData API エンドポイントを追加するプラグイン

PowerCMSについても少しずつ Data API に関する問い合わせをいただくようになってきました。以前製品発表のイベントでも JSON API について言及していたのですが(対応が遅れていましたが)、このたびバナー (Banner/Campaign) とカスタムオブジェクト (カスタム項目 - CustomObject) のデータ取得に対応しました。

このプラグインは現在ベータ版につき未サポートとなっています。次期マイナーバージョンアップでの正式提供を予定しています。

ダウンロード

使い方

基本的にはMTの記事取得などの仕様と同じように利用します。

バナーの一覧の取得

GET https://example.com/your-mt-api.cgi/v1/sites/{blog_id}/banners

個別バナーの取得(IDを指定)

GET https://example.com/your-mt-api.cgi/v1/sites/{blog_id}/banners/{banner_id}

カスタムオブジェクトの一覧の取得

GET https://example.com/your-mt-api.cgi/v1/sites/{blog_id}/customobjects

個別カスタムオブジェクトの取得(IDを指定)

GET https://example.com/your-mt-api.cgi/v1/sites/{blog_id}/customobjects/{customobjects_id}

指定可能なパラメタ

一覧取得時には以下のパラメタが指定可能です。

sortOrderdescend(降順 - デフォルト)またはascend
search検索キーワード
group_id / groupグループのIDもしくは名前(指定がある時、ソート順はグループの設定が利用されます)
limit / offsetロードする数とオフセット値
statusステータス(※)

※オブジェクトによって指定文字列が異なることに注意してください。バナーでは、Draft(下書き)、Publishing(公開)、Scheduled(公開予約)、Ended(公開終了)、カスタムオブジェクトでは、Draft(下書き)、Publishing(公開)、Review(承認待ち)、Future(公開予約)、Closed(公開終了)。
この指定が有効になるのは、認証付きのAPIリクエストで且つユーザーがそのオブジェクトを管理できる権限を持っているユーザーのみです。認証無しのAPIリクエストでは、常にステータスが「公開(2)」のもののみがリストの対象になります。

バナーのみに指定可能なパラメタ

以下のパラメタはバナーのみに指定可能です。

activeステータスが「公開」で、有効期間内のバナーのみを返します。
sortByソートに利用するカラム(authored_on, modified_on, publishing_on, period_on, id (デフォルト), titleのいずれか)
searchFields検索対象カラム(カンマ区切り、対象はtitle, text, memo)

カスタムオブジェクトのみに指定可能なパラメタ

以下のパラメタはカスタムオブジェクトのみに指定可能です。

folderフォルダのパスを指定してフィルタリングします。
classクラス名を指定します。カスタムオブジェクトのサブクラスをロードするときは必須です。例えばプラグイン名が「Book」のとき、class=book のようにパラメタを追加します。
sortByソートに利用するカラム(authored_on, modified_on, period_on, id (デフォルト), keywords, nameのいずれか)
searchFields検索対象カラム(カンマ区切り、対象はname, body, keywords)
カテゴリー
PowerCMS 4
プラグイン

ページの先頭へ