ガイド
CDN API・Newt API

CDN API・Newt APIの概要

CDN API・Newt APIとは
CDN API・Newt APIの違い
メソッド一覧
CDN API・Newt APIに関するリソースの一覧
リファレンス
CDNとは
クエリの使い方
SDK

CDN API・Newt APIとは

Newtでは、作成したリソースを取得するために、「CDN API」と「Newt API」の2つのAPIを用意しています。
どちらのAPIも、コンテンツや管理画面の設定値を取得するためのAPIです。様々なクエリを利用して、取得するデータをフィルタしたり、データの順番を変更したりできます。
また、JavaScript SDK をご利用いただくことで、APIへのリクエスト処理を簡単に実行できます。

詳細については、以下のリファレンスをご確認ください。

CDN API・Newt APIの違い

どちらもコンテンツや管理画面の設定値をAPI経由で取得できるという点では同じですが、以下の2点が異なります。

CDN経由でデータを取得するか
CDN APIではCDN（コンテンツ配信ネットワーク）経由でデータを取得します。キャッシュされたデータを利用することで、高速にデータが配信されます。
一方、Newt APIではCDNを経由せずにサーバーから直接データを取得します。

公開済みのコンテンツを取得するか、下書き中のコンテンツも取得するか
CDN APIでは、公開済みのコンテンツのみを取得します。
一方、Newt APIでは下書き中のコンテンツも含む、最新のコンテンツ情報を取得します。

まとめると以下のようになります。

	CDN経由でデータを取得するか	取得するコンテンツ
CDN API	◯	公開済みのコンテンツ
Newt API	×	下書きも含む最新のコンテンツ

基本的にはCDN APIをご利用いただくことで、公開済みのデータに絞って、高速にデータを取得をいただけます。
Newt APIは、プレビュー環境の作成時など、下書き情報を取得する場合に最適なAPIとなります。

メソッド一覧

CDN APIでも、Newt APIでも以下のメソッドをご利用いただけます。
{appUid} や {modelUid} のところは、取得したいコンテンツのApp UIDや、モデルUIDを入力していただく形となります。

メソッド	エンドポイント
コンテンツ一覧の取得	/v1/{appUid}/{modelUid}
単一コンテンツの取得	/v1/{appUid}/{modelUid}/{contentId}
App情報の取得	/v1/space/apps/{appUid}