API一覧

nor.のシステムで提供するAPIは、以下の3つのグループに分かれています。

APIグループ名 説明
Contents Holder Unit Management API 自分が所属するコンテンツホルダー・ユニットの情報を管理するためのAPI。使用するには、対象のコンテンツホルダー・ユニットの権限が付与されたアクセストークンが必要。
Curator Unit Management API 自分が所属するキュレーター・ユニットの情報を管理するためのAPI。使用するには、対象のキュレーター・ユニットの権限が付与されたアクセストークンが必要。
Search API コンテンツホルダー・ユニットによって作成された記事を検索するためのAPI。使用するには、アクセストークンが必要。

「ユニットについて」

「コンテンツホルダー・ユニット」および「キュレーター・ユニット」については、nor.cmsから ダウンロード可能な「CMS操作説明書」をご確認ください。

Search API

API名 概要
search/contentsholder/units.list 作成されたユニットの一覧を取得
search/contentsholder/posts.list 作成された記事の一覧を取得
search/contentsholder/labels.list ラベルの一覧を取得
search/contentsholder/postEvents.list イベントの一覧を取得

Curator Unit Management API

API名 概要
curator/units.info ユニットの情報を取得
curator/curations.list 作成したキュレーションの一覧を取得
curator/curations.info 作成したキュレーションの情報を取得
curator/curations.create キュレーションを作成
curator/curations.update 作成したキュレーションを更新
curator/curations.delete 作成したキュレーションを削除
curator/tags.list 作成したタグの一覧を取得
curator/tags.info 作成したタグの情報を取得
curator/tags.create タグを作成
curator/tags.update 作成したタグを更新
curator/tags.delete 作成したタグを削除

Contents Holder Unit Management API

API名 概要
contentsholder/units.info ユニットの情報を取得
contentsholder/posts.list 作成した記事の一覧を取得
contentsholder/posts.info 作成した記事の情報を取得
contentsholder/posts.create 記事を作成 ( マークダウン )
contentsholder/posts.update 作成した記事を更新
contentsholder/posts.delete 作成した記事を削除
contentsholder/images.upload 画像をアップロード
contentsholder/images.update アップロードした画像を更新
contentsholder/images.delete アップロードした画像を削除
contentsholder/labels.list ラベルの一覧を取得
contentsholder/series.list 作成した連載の一覧を取得
contentsholder/series.info 作成した連載の情報を取得
contentsholder/series.create 連載を作成
contentsholder/series.update 作成した連載を更新
contentsholder/series.delete 作成した連載を削除
contentsholder/topics.list 作成したトピックの一覧を取得
contentsholder/topics.info 作成したトピックの情報を取得
contentsholder/topics.create トピックを作成
contentsholder/topics.update 作成したトピックを更新
contentsholder/topics.delete 作成したトピックを削除

オブジェクト

APIのレスポンス内で使用されている各種オブジェクトの詳細

表中の「listで取得可」列に○が付いている項目は、list系APIのレスポンスでも返す項目を表しています。list系以外のAPI(info系APIなど)は基本的にすべての項目をレスポンスで返します。

API名 概要
pagingオブジェクト 画面側のページング処理で必要とされる情報
contentsholder unitオブジェクト コンテンツホルダー・ユニットの情報
contentsholder postオブジェクト コンテンツホルダー・ユニットの記事の情報
contentsholder imageオブジェクト コンテンツホルダー・ユニットの画像の情報
contentsholder labelオブジェクト コンテンツホルダー・ユニットのラベルの情報
contentsholder seriesオブジェクト コンテンツホルダー・ユニットの連載の情報
contentsholder topicオブジェクト コンテンツホルダー・ユニットのトピックの情報
curator unitオブジェクト キュレーター・ユニットの情報
curator curationオブジェクト キュレーター・ユニットのキュレーションの情報
curator tagオブジェクト キュレーター・ユニットのタグの情報
search contentsholder unitオブジェクト コンテンツホルダー・ユニットの情報
search contentsholder postオブジェクト コンテンツホルダー・ユニットの記事の情報
search contentsholder labelオブジェクト コンテンツホルダー・ユニットのラベルの情報