# Kollus CMS API

### Kollus CMS API <a href="#kolluscmsapi-kolluscmsapi" id="kolluscmsapi-kolluscmsapi"></a>

***

#### [Kollus VOD API](https://kollus-vod-jp.readme.io/reference/1a4e078bdc3a93d1264b1fe88c4f4fe7) <a href="#kolluscmsapi-kollusvodapi" id="kolluscmsapi-kollusvodapi"></a>

#### [Kollus LIVE API ](https://kollus-live-jp.readme.io/reference/8b09ca1457b528b823c66d698beba686) <a href="#kolluscmsapi-kollusliveapi" id="kolluscmsapi-kollusliveapi"></a>

### 1. API Interface URI 規則 <a href="#kolluscmsapiapiinterfaceuri-gui-ze" id="kolluscmsapiapiinterfaceuri-gui-ze"></a>

***

**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 <a href="#kolluscmsapi-apimessage" id="kolluscmsapi-apimessage"></a>

***

### API 規格 <a href="#kolluscmsapiapi-gui-ge" id="kolluscmsapiapi-gui-ge"></a>

```
json, utf8
```

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

#### API response structure <a href="#kolluscmsapi-apiresponsestructure" id="kolluscmsapi-apiresponsestructure"></a>

#### メッセージノード <a href="#kolluscmsapi-messjindo" id="kolluscmsapi-messjindo"></a>

* **error** : エラーコードです。0以外はエラーです。(必須)
* **message** : API呼び出しの結果を文字列で表示します。
* **result** : API呼び出しが成功の場合の結果を表示します。

#### Success Message <a href="#kolluscmsapi-successmessage" id="kolluscmsapi-successmessage"></a>

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

#### Fail Message <a href="#kolluscmsapi-failmessage" id="kolluscmsapi-failmessage"></a>

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

```
```

### 3. API 認証方法 <a href="#kolluscmsapiapi-ren-zheng-fang-fa" id="kolluscmsapiapi-ren-zheng-fang-fa"></a>

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 サービスアカウント認証方法 <a href="#kolluscmsapi-kollussbisuakaunto" id="kolluscmsapi-kollussbisuakaunto"></a>

* 各サービスアカウントに割り当てられているaccess\_token(アクセストークン)を確認します。
* アクセスする全てのapiにGET or POSTでaccess\_tokenを一緒に送信するとサービスアカウントに関するAPIが使用できます。

### その他 <a href="#kolluscmsapi-sono" id="kolluscmsapi-sono"></a>

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