APIトークンを生成する

記事番号:040471

APIトークンは、外部のプログラムで使用するkintone REST APIの認証に使用します。
リクエストの「X-Cybozu-API-Token」ヘッダーにAPIトークンを指定することで、リクエストが認証され、APIが実行されます。複数のAPIトークンをカンマ区切りで指定することも可能です。

APIトークンを使用したリクエストの例:
GET /k/v1/record.json?app=7&id=100 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-API-Token:cJrAD9Es62qm0Z3eE6uzQQmaDxM3q9jiDay1oysX
複数のAPIトークンを使って、顧客名をルックアップで取得する例:
curl -X POST -H "X-Cybozu-API-Token: cJrAD9Es62qm0Z3eE6uzQQmaDxM3q9jiDay1oysX, 6oDAV8hCY6HTa1AC6EZbNe2dpc1t8QnWZrHOMgMb" "https://(サブドメイン名).cybozu.com/k/v1/record.json" -H "Content-Type: application/json" -d '{app: 20, record: {"顧客名": {value: "金都運総研"}}}'

APIトークンを使用した認証の詳細は、次のページの「ユーザー認証」を参照してください。
kintone REST API の共通仕様

APIトークンを生成する手順

  1. レコード一覧画面の右上にある歯車の形をしたアプリ設定アイコンをクリックし、「設定」タブの「カスタマイズ/サービス連携」にある[APIトークン]を選択します。 スクリーンショット:設定アイコン

  2. [生成する]をクリックします。 スクリーンショット:生成するボタン

  3. 生成されたAPIトークンに対して、許可する操作のチェックボックスを選択します。 スクリーンショット:許可する操作のチェックボックス

  4. 必要に応じて、メモの「編集する」アイコンをクリックして、各APIトークンのメモを入力します。
    担当者や利用目的などを記載しておくことで、APIトークンの管理に役立ちます。 スクリーンショット:メモ入力画面

    • 入力欄の右下の角をマウスでつかんで広げると、横幅と縦幅を広げることができます。
    • 200文字まで入力できます。
  5. メモを入力後、「保存」アイコンをクリックしてメモを保存します。 スクリーンショット:保存ボタン

  6. 画面右下の[保存]をクリックします。
    APIトークンの設定が保存されます。

  7. 保存した設定を運用環境に反映する場合は、画面右上の[アプリを更新]をクリックします。

  8. 確認ダイアログで[アプリを更新]をクリックします。