データプロトコル

データは HTTP を用いて送受信します。 それぞれのデータは Atom (RFC 4287) を基本としたデータ形式で表現します。 データの表現形式は対応するドキュメントを参照してください。

API を利用するためには、アプリケーションの認証とユーザーからの認可が必要です。認証と認可に関しては次の章 (認証と認可) を参照してください。 API リクエストにおいて、認証エラーの場合は 400 番台、場合によっては 500 番台のステータスコードを返します。サービスが何らかの理由で利用不可能になっている場合にはステータスコード 503 を返します。

リクエストとレスポンスの例は以降の章で示します。 リクエストの例では、Host ヘッダーや Authorization ヘッダーなどを省略していますので、実際のリクエストでは適切なヘッダーを付与してください。

データの形式

次に示す Atom の基本的な要素に関しては記述を省略してあります。

要素 説明
/feed/title サイボウズ Live のことです。
/feed/link サイボウズ Live の URL です。
/feed/author フィードを取得しているユーザーの情報。
/feed/entry/id アイテムの ID。
/feed/entry/link アイテムの URL。
/feed/entry/title アイテムのタイトル。
/feed/entry/summary 詳細情報やメモ。
/feed/entry/updated アイテムの更新日。
/feed/entry/category アイテムが属するデータの種類。

サイボウズ Live のデータには大きく分けて次の二種類があります。 category はこのいずれかと、アプリケーション名 (MESSAGE など) を含みます。

  • MYPAGE - チャットや新着情報のような個人のデータです。
  • GROUP - 掲示板や ToDo リストのようなグループのデータです。

データへのアクセスレベル

API 経由でアクセスできるデータには次のものがあります。 開発するアプリケーションに応じて必要なアクセスレベルを選択してください。 レベルZはインストールして利用する種類のクライアントアプリケーションのみ選択できます。

  • レベルA - 簡易情報の読み込みが可能。
  • レベルB - 詳細情報の読み込みが可能。
  • レベルC - 共有情報の読み込みと、部分的なデータの更新が可能。
  • レベルD - データの追加、変更、削除が部分的に可能。
  • レベルZ - API が提供する全ての機能を利用可能。

それぞれのアクセスレベルでアクセスできるデータの種類は次の表を参照してください。

注釈

レベルC とレベルD は今後のバージョンアップでの提供を予定しているものです。

MYPAGE のデータ

機能名 説明 A B C D Z
新着情報 新着情報のタイトルとサマリを取得可能。 O O O O O
新着情報の状態を既読に変更可能。 O O O O O
いいね!通知 いいね!通知のタイトルとサマリを取得可能。 O O O O O
いいね!通知を既読に変更可能。 O O O O O
いいね! いいね!をつけた人を取得可能。 O O O O O
いいね!をつける/取り消すことが可能。 O O O O O
個人予定 個人予定の日付とタイトルを取得可能。 O O O O O
個人予定のメモを取得可能。   O O O O
個人予定の参加者、設備を取得可能。     O O O
個人予定のコメントを取得可能。     O O O
お気に入り お気に入りの一覧を取得可能。 O O O O O
アイテムをお気に入りに登録することが可能。 O O O O O
アイテムからお気に入りを削除することが可能。 O O O O O
コネクション コネクションの表示名を取得可能。   O O O O
グループフォルダ フォルダ情報を取得可能。 O O O O O
ファイルダウンロード ファイルの内容を取得可能。     O O O
アイコン画像 ユーザーのプロフィール画像を取得可能。     O O O

GROUP のデータ

機能名 説明 A B C D Z
グループ設定 グループの設定情報を取得可能。 O O O O O
イベント イベントの日付とタイトルを取得可能。 O O O O O
イベントのメモを取得可能。   O O O O
イベントの添付ファイルの表示名を取得可能。     O O O
イベントのコメントを取得可能。     O O O
ToDoリスト ToDoリストのタイトルと期日を取得可能。 O O O O O
ToDoリストのステータスを取得可能。 O O O O O
ToDoリストのメモを取得可能。   O O O O
ToDoリストの添付ファイルの表示名を取得可能。     O O O
ToDoリストのコメントを取得可能。     O O O
ToDoカテゴリ カテゴリ情報を取得可能。   O O O O
掲示板 掲示板のタイトルと本文を取得可能。   O O O O
掲示板の添付ファイルの表示名を取得可能。     O O O
掲示板のタイトルと本文を登録可能。       O O
掲示板のタイトルと本文を編集可能。       O O
掲示板を削除可能。       O O
掲示板を管理者権限で削除可能。         O
掲示板のコメントを取得可能。     O O O
掲示板のコメントを登録可能。 [1]       O O
掲示板カテゴリ カテゴリ情報を取得可能。   O O O O
コメント コメントを取得可能。     O O O
コメントを登録可能。       O O
コメントを削除可能。       O O
コメントを管理者権限で削除可能。         O
ファイル タイトル、メモを取得可能。   O O O O
ファイルフォルダ フォルダ情報を取得可能。   O O O O
ファイルダウンロード ファイルの内容を取得可能。     O O O
メンバー名簿 グループに所属するメンバーの名前を取得可能。   O O O O
アイコン画像 グループのアイコンを取得可能。     O O O
[1]非推奨の方法です。コメント用の API を使うようにしてください。

注釈

コメントを扱う API には2種類あります。

  • タイトルや本文を含むフィードに埋め込まれた形式。
  • コメントだけを扱う形式。(推奨)

リクエスト制限

  • 1日当たりの最大リクエスト数は6000回です。 (ひとつのユーザ認証トークン当たり)
  • POST 可能なデータサイズの最大値は50MBです。