Kollus CMS API

Kollus VOD API

Kollus

Kollus LIVE API 

API Interface URI

規則

Kollus API는 아래와 같은 규칙을 갖도록 구성었으며, 향후 API의 업그레이드 시에도 하위 버전의 안정적인 버전 지원을 위해 API 경로에 버전을 포함하고 있습니다.버전의 업그레이드가 진행될 때 이전 버전의 전체 지원이 제한되지 않을 때 까지 해당 버전은 지속적으로 지원될 것 입니다.は以下の規則で構成されていて、今後のAPI更新に伴って下位バージョンにも安定的に対応するため、APIパスにバージョン情報が含まれています。

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

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

• api_domain : api.kr.kollus.com, api.jp.kollus.com 해당 도메인은 서비스 지역에 따라 변경될 수 있습니다.com ドメインはサービス地域によって変更される場合があります。
• major_version : API의 Major 버젼입니다. 현재 0 입니다. APIのMajorバージョン (現在0)
• path : api 경로 입니다. 각 경로는 아래와 같은 규칙을 갖습니다. apiパスです。各パスは以下のようなルールで構成されています。
• container : controller 이전까지의 path controller以前までのpath
• controller : action의 묶음 단위 actionの束の単位
• action : 행위 行動(action)를 뜻하는 기능を意味する機能(method)이다. 예를 들자면, create, です。例えば、create, edit, delete, read, index(=list)などがあります。
• parameters : ex) api_key=443ede01f6bc021514233cea82a09aee&content_provider_key=kollus

API Message

API

規格

json, utf8

각 API의 기본 결과 문자열은 UTF8로 인코딩되어 있으며 json 포멧을 기본으로 하고 있습니다.各APIのデフォルト結果文字列はUTF8でエンコードされていてjsonフォーマットになっています。

API response structure

メッセージノード

• error : 에러 코드입니다. 0이 아니면 오류 입니다. (필수 エラーコードです。0以外はエラーです。(必須)
• message : API 호출 후 성공 여부에 대한 결과 문자열을 보여 줍니다. API呼び出しの結果を文字列で表示します。
• result : API 호출 성공시 결과값입니다. API呼び出しが成功の場合の結果を表示します。

Success Message

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

Fail Message

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

API

認証方法

Kollus API를 사용하기 위해선 Kollus 시스템에서 제공하는 API 인증 중 하나의 인증을 따라야 API의 사용이 가능합니다.

Kollus API 인증은 다음의 순서로 인증 Level(레벨)이 있습니다. 아래 3가지 인증 방법들을 이용해 API를 사용할 수 있습니다.

anonymous access

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

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

1. anonymous access

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

2. ip base accessKollus 시스템에 ip base 인증를 등록하여 인증처리 합니다. Kollus 시스템 관리자에게 별도 요청해야합니다.

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

3. access_token access

   각 서비스 계정에 할당되어 있는 access_token(접근 토큰)로 접근합니다.アクセストークン)を利用して各サービスアカウントへアクセスします。

Kollus

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

• 各サービスアカウントに割り当てられているaccess_token(접근 토큰)을 확인합니다.

• 접근 하려는 모든 api에 GET or POST로 access_token을 같이 보내면 서비스 계정에 관련된 API들 사용할수 있습니다.

기타 사항

• Restful API로 GET, POST만 사용합니다.

  アクセストークン)を確認します。

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

その他

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