kintone REST API リクエストを送信する

kintone REST API および User API で利用できます。

• PCとモバイルで利用できます。
• 本 API は非同期リクエストとなります。同期的に処理したい場合はこちらの Tips をご参照ください。
• kintone REST API のファイルアップロード API、ファイルダウンロード APIでは利用できません。
  これらを利用する際には、CSRF トークンを取得して、HTTP リクエストで実行してください。
• User APIのファイルアップロード API、URI の末尾が .json 以外の API（ユーザーエクスポート API(CSV)など）では利用できません。
• kintone.api() を利用する場合、リクエストヘッダの指定は不要です。

関数

kintone.api(pathOrUrl, method, params, successCallback, failureCallback)

引数

返り値

引数の successCallback を省略した時、kintone.Promise オブジェクトを返します。
※ この kintone.Promise オブジェクトを return することで、kintone.api() の実行を待ってから次の処理を実行できるイベントがあります。
対応しているイベントはこちらをご参照ください。

successCallback を指定した場合返り値はありません。

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

サンプル

コールバックを使用した記述方法

kintone.Promise オブジェクトを使った記述方法

URL を取得する（クエリ文字列無し）

省略した形式の API のパスから、URL を生成します。

関数

kintone.api.url(path, detectGuestSpace)

引数

返り値

URL 文字列。

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

サンプル

URL を取得する（クエリ文字列付き）

API のパスとパラメータを受け取ってクエリ文字列付きの URL を生成します。

関数

kintone.api.urlForGet(path, params, detectGuestSpace)

引数

返り値

クエリ文字列が付与され、パラメータが URL エンコードされた URL 文字列。

// パラメータにオブジェクトや配列が渡された場合、クエリ文字列は以下のように展開されます。
// params = {app: 4, fields: ['record_no']}
https://{subdomain}.cybozu.com/k/v1/records.json?app=4&fields[0]=record_no

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

サンプル

CSRF トークンの取得

HTTP メソッドが POST, PUT, DELETE である API すべてにおいて利用できます。

• PCとモバイルで利用できます。
• HTTP メソッドが GET の API では CSRF トークンは不要です。

関数

kintone.getRequestToken()

引数

なし

返り値

文字列

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

有効期間

最終アクセス時間から 86400 秒(1日)

サンプル

API がパラメータをクエリで受け付ける場合の例

https://(サブドメイン名).cybozu.com/k/v1/records.json?__REQUEST_TOKEN__=72A0C9714B6E1C086D24BBC11A5C3508

API がパラメータをリクエストボディで受け付ける場合の例

以下のリクエストヘッダを API 実行時に指定します。