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. 「レコードの一覧」画面で、画面右上にある歯車の形をした[アプリを設定]アイコンをクリックします。
    スクリーンショット：[アプリを設定]アイコンが枠線で強調されている

  2. 「アプリの設定」画面で、[設定]タブの「カスタマイズ／サービス連携」にある[APIトークン]をクリックします。

  3. 「APIトークン」画面で、[生成する]をクリックします。
    スクリーンショット：生成するボタン

  4. 生成されたAPIトークンに対して、「アクセス権」で許可する操作にチェックを入れます。 スクリーンショット：許可する操作のチェックボックス

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

    • 入力欄の右下の角をマウスでつかんで広げると、横幅と縦幅を広げることができます。
    • 200文字まで入力できます。

  6. ✔の形をした[保存]アイコンをクリックしてメモを保存します。
    スクリーンショット：保存ボタン

  7. 画面右下の[保存]をクリックします。

  8. 画面右上の[アプリを更新]をクリックします。

  9. 「アプリを更新」ダイアログで、[アプリを更新]をクリックします。