Kollus CMS API

Kollus CMS API

---

Kollus VOD API

Kollus LIVE API

1. API Interface URI 規則

---

Kollus APIは以下の規則で構成されていて、今後のAPI更新に伴って下位バージョンにも安定的に対応するため、APIパスにバージョン情報が含まれています。

バージョン更新の際には、以前バージョンが完全に対応できる状態になるまで該当バージョンは持続的に対応します。

http://[api_domain]/[major_version]/{path:[container]/[controller]/[action]}?[parameters]

• api_domain : api.jp.kollus.com, api-vod-jp.kollus, c-api-jp.kollus.com ドメインはサービス地域によって変更される場合があります。

• major_version : APIのMajorバージョン (現在0)

• path : apiパスです。各パスは以下のようなルールで構成されています。

• container : controller以前までのpath

• controller : actionの束の単位

• action : 行動(action)を意味する機能(method)です。例えば、create, edit, delete, read, index(=list)などがあります。

• parameters : ex) api_key=443ede01f6bc021514233cea82a09aee&content_provider_key=kollus

2. API Message

---

API 規格

json, utf8

各APIのデフォルト結果文字列はUTF8でエンコードされていてjsonフォーマットになっています。

API response structure

メッセージノード

• error : エラーコードです。0以外はエラーです。(必須)

• message : API呼び出しの結果を文字列で表示します。

• result : API呼び出しが成功の場合の結果を表示します。

Success Message

{
	"error" : 0
	, "message" : "Sucessfully created."
	, "result" : {
		"key" : "test_key"
	}
}

Fail Message

{
	"error" : 1
	, "message" : "Failed to create."
}

3. API 認証方法

Kollus APIを使用する為には、Kollusシステムにて提供するAPIの中の一つに認証を行う必要があります。

Kollus API認証は以下の順で認証レベルがあります。以下3つの認証方法を利用してAPIを使用することが出来ます。

1. anonymous access

   該当URIがanonymous accessの場合、自動認証が通ります。anonymous accessをサポートするapiは制限的に使われています。

2. ip base access

   Kollusシステムにip baseの認証を登録して認証処理します。Kollusシステム管理者まで申し込んでください。

3. access_token access

   access_token(アクセストークン)を利用して各サービスアカウントへアクセスします。

4. Kollus サービスアカウント認証方法

• 各サービスアカウントに割り当てられているaccess_token(アクセストークン)を確認します。

• アクセスする全てのapiにGET or POSTでaccess_tokenを一緒に送信するとサービスアカウントに関するAPIが使用できます。

その他

• Restful APIとしてGET, POSTのみ使用します。