kintone REST APIとは
kintone REST APIは、kintoneのレコードやアプリ、スペースを操作できるAPIです。
kintoneで管理しているデータを外部システムに渡すときや、外部システムからkintoneへデータを登録、更新、削除するときに利用できます。
API実行に必要な情報
Web APIを使ってみよう で説明したように、kintone REST APIでも、APIを実行するには次の情報が必要です。
それぞれ詳しく見ていきましょう。
URL
利用したいAPIのパスを指定します。どのリソースに対してリクエストを行うかをURLで指定します。
URLの一覧は、
REST API一覧
を確認してください。
メソッド
URLで指定したリソースをどう扱うのか指定します。
GET/POST/PUT/DELETEのいずれかを指定します。
リクエストヘッダー
APIを実行するリクエストには、認証のためのヘッダーを追加する必要があります。
kintone REST APIのリクエストヘッダーに格納できる認証情報は、次の2種類があります。
- パスワード認証
リクエストヘッダーに「X-Cybozu-Authorization」ヘッダーを追加し、値には「ログイン名:パスワード」をBASE64エンコードしたものを指定します。 - APIトークン認証
アプリごとに生成するAPIトークンを使用して、kintone REST APIを処理できます。
リクエストヘッダーに「X-Cybozu-API-Token」ヘッダーを追加し、値にはアプリごとに生成するAPIトークンを指定します。
APIトークンを生成する方法は、 APIトークンを生成する を確認してください。
APIトークンを使用すると、よりセキュアにREST APIを実行できます。
アプリごとに生成するため、他のアプリに影響を与えることがありません。
リクエストヘッダーの仕様や制限を知りたい場合は kintone REST APIの共通仕様 を確認してください。
リクエストパラメーター
Web APIを使ってみよう
で、REST APIのリクエストパラメーターの役割は「具体的なリソースの操作内容」と説明しました。
kintone REST APIでは、「どのアプリか」「どのレコードか」といった値をリクエストパラメーターに設定します。
そのため、使用するAPIやリクエストの内容によって、APIに渡すリクエストパラメーターも異なります。
kintone REST APIの各ドキュメントページに記載されている「パラメーター」を参考に、パラメーターを指定してください。
kintone REST APIの一覧
おわりに
この記事では、kintone REST APIの基礎知識について説明しました。
次は、実例を用いてkintone REST APIの実行方法を学びましょう。
kintone REST APIを使ってレコードデータを取得してみよう