API クライアントとコンテンツ管理 API

導入

私の続きで 前の投稿 PaaS ベースの Optimizely CMS でのコンテンツ管理 API と OpenID Connect 認証の活用について、SaaS ベースの CMS プラットフォーム内の配信メカニズムを詳しく調べます。 驚くべきことに、機能の大部分はすぐに利用でき、システムにシームレスに統合されています。 この記事では、利用可能な機能の簡単なプレビューと、定義およびコンテンツ管理用に公開された API の構成に関するガイドを提供します。

注記： これらの機能を検討している間、SaaS プラットフォームはまだベータ段階にあり、API は現在バージョン 0.5 であることに留意することが重要です。 SaaS CMS が一般提供に移行する際に変更が発生する可能性があります。

API クライアントの構成 (OpenID Connect パッケージに相当)

API クライアント機能は SaaS CMS にプリインストールされており、セットアップは Open ID Connect パッケージを使用した PaaS プラットフォームで見つかったものとほぼ同じです。 このツールは、下の画像で強調表示されているように、[設定]および[アクセス権]セクション内にあります。

API クライアント インターフェイスにアクセスすると、クライアント ID を作成できます。クライアント シークレットは自動的に生成されます。ページを離れると取得する方法がないため、これを安全に保管してください。 「クライアントにユーザーの偽装を許可する」オプションは一目瞭然です。 これを有効にすると、クライアントは CMS 内で別のユーザーとして機能できるようになります。

資格情報の使用

Postman を使用してこれらの資格情報を利用し、後続の API 呼び出し用の JWT トークンを取得する方法を示します。 Bearer Auth Token を取得するには、指定された URL に対して GET 呼び出しを行う必要があります。

https://app-xxxprod.cms.optimizely.com/_cms/v0.5/oauth/token

リクエストとともに必要なパラメータを送信します。 grant_type、 client_id、 client_secret、およびオプションで act_as、将来のリクエスト用にトークンが生成されます。 特に、このトークンは 300 秒後に自動的に期限切れになります。

例：

Bearer Tokenを使用したAPIへの認可

Bearer Token が生成されると、このトークンを「Authorization」ヘッダー パラメーターとして渡すことで、後続の API リクエストを認証できるようになります。

例：

コンテンツ定義 API

ベアラー トークンを取得したので、Content and Definitions API を操作できるようになります。 最初に調査する API は、Content Definitions API です。 詳細な API リファレンスを見つけることができます ここ。

コンテンツタイプの取得

次の URL への単純な GET リクエストにより、CMS 内のすべてのコンテンツ タイプのリストが提供されます。

https://app-xxxprod.cms.optimizely.com/_cms/v0.5/contenttypes

例：

特定の既知の型の詳細のみを取得するには、定義名 (キー) を URL に渡します。

https://app- xxxprod.cms.optimizely.com/_cms/v0.5/contenttypes/articlepage

コンテンツタイプの作成

コンテンツ タイプを作成するには、同じ URL に対して POST リクエストを実行し、必要なパラメータを渡します。

例：

コンテンツ {配信} API

Content API への API リファレンスは次の場所にあります。 コンテンツの作成 (optimizely.com)

コンテンツの取得

コンテンツ アイテムを取得するには、ページの GUID をキーとして使用して、指定された URL に対して GET リクエストを実行します。 キーは UUID 形式であるため、ダッシュを含めないでください (例: 115988243510434482925671c3ee601a)

https://app- xxxprod.cms.optimizely.com/_cms/v0.5/content/{key}

例：

結論

ご覧のとおり、API と対話して必要な関連情報を取得するのは非常に簡単で、プログラムによってコンテンツ モデルとこれらのモデルのインスタンスを作成することもできます。 これが最初からすべて含まれており、コンテンツ定義の作成プロセスをどのように管理するかを決定するための多くの余地を提供してくれるのは素晴らしいことです。

2024 年 3 月 6 日