カレンダー API の概要

LINE WORKS カレンダー API(以下、「カレンダー API」、または「API」)は、HTTP リクエストで活用できる REST API です。結果は　JSON　形式で返却し、認証には OAuth 2.0 を使用します。

カレンダー API は、LINE WORKS カレンダーサービスの機能のうち、よく使う機能を API で提供しています。

API共通情報

提供環境

LINE WORKS では、テスト環境とサービス環境の 2 つを提供していますが、カレンダー API ではサービス環境のみ提供ています。

サービス環境: https://apis.worksmobile.com

オペレーションをリクエストするときは HTTP メソッドとリクエスト URL を結合します。例えば、サービス環境でカレンダーを作成するオペレーションは、以下のようになります。

例) カレンダー作成オペレーション

POST https://apis.worksmobile.com/{API ID}/calendar/createCalendar

サービス環境に対するリクエスト URL は、各 API の説明を参照してください。

Request 共通

LINE WORKS アクセストークンとコンシューマーキー

APIを呼び出すときには必ずヘッダーにアクセストークンとコンシューマーキーを含めなければなりません。アクセストークンはログイン時に発行され、ログインするたびに再発行されます。

コンシューマーキーの発行については、API 共通ガイドを参考にしてください。

ヘッダーに LINE WORKS アクセストークンとコンシューマーキーを設定する方法は以下の通りです。

httpMethod.setRequestHeader("Authorization", "LINE WORKS アクセストークン");
httpMethod.setRequestHeader("consumerKey", "コンシューマーキー");

userId

カレンダー API を利用する際は API Gateway(APIGW) にて cookie をもとに認証します。このとき APIGW では cookie をパースして userId パラメータを自動的に追加するため、カレンダー API を呼び出す際に別途 userId パラメータ値を指定する必要はありません。

参考

API 認証関連の詳細な内容については、API 認証の準備を参考にしてください。

Response 共通

API 呼び出しに失敗するとエラーの内容が返されます。

プロパティ	タイプ	必須	説明
result	String	Y	呼び出しに失敗した場合には、固定値 “fail” を返します。
errorMessage	String	Y
serverName	String	Y	API が呼び出されたカレンダーサーバー
calledTimestamp	String	Y	呼び出された時刻
requestUri	String	Y	呼び出された API URI
remoteIp	String	Y	カレンダーサーバーを呼び出した IP アドレス
result	String	Y	原因追跡のためのメッセージ

以下にサンプルコードを示します。

{
    "result": "fail",
    "errorMessage": "{\"serverName\":\"cvcapi02.caldf\",
                    \"calledTimestamp\":\"2016-08-25T14:58:24.760+09:00\",
                    \"requestUri\":\"/apigw/deskhomeBO/getScheduleList\",
                    \"remoteIp\":\"10.64.54.204\",
                    \"result\":\"com.naver.calendar.apigw.post.bean.CalendarException: cannot find userConf. userId\\u003d33578002\"
                }"
}

LINE WORKS Developers