RESTful API JavaScript SDK

RESTful API JavaScript SDKについて

RESTful API を JavaScript から操作する SDK を公開します。これらの機能を利用することで、アプリや他のサービスとのスムーズな連携、Jamstack による配信、あるいは静的ページのみを公開して検索やフォームなどの動的コンテンツを API 経由で提供するなど、コンテンツの活用範囲を広げることが可能になります。

JavaScript SDKはGitHubよりダウンロード可能です。

サンプルコード

GitHubのdistディレクトリ内にあるpt-restful-api-client.js(もしくはpt-restful-api-client.min.js)を読みこんだ後でコードを記述します。詳細はGitHubのREADME.mdをご覧ください。

初期化

const client = new PTRESTfulAPIClient('https://example.com/powercmsx/api', 1);  // 引数:アプリケーションへのパス, APIバージョン

オブジェクト一覧の取得例

async function getList() {
    const params = {
        sort_by: 'published_on',
        sort_order: 'desc',
        limit: 5,
    };
    const response = await client.listObjects('entry', 1, params); // 引数:モデル名, ワークスペースID, パラメーター
    const json = await response.json();
    // json.itemsにオブジェクト一覧が入っている
}