Generating API Tokens

Article Number:040471

API tokens are used for authenticating kintone REST API requests sent from external programs.

Specifying an API token in the "X-Cybozu-API-Token" header of your REST API request authenticates the request, and the API is executed. You can also specify multiple API tokens with commas in between.

Example of a REST API request with an API token:
GET /k/v1/record.json?app=7&id=100 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-API-Token:cJrAD9Es62qm0Z3eE6uzQQmaDxM3q9jiDay1oysX
Example of using multiple API tokens to look up a customer name:
curl -X POST -H "X-Cybozu-API-Token: cJrAD9Es62qm0Z3eE6uzQQmaDxM3q9jiDay1oysX, 6oDAV8hCY6HTa1AC6EZbNe2dpc1t8QnWZrHOMgMb" "https://subdomain-name.cybozu.cn/k/v1/record.json" -H "Content-Type: application/json" -d '{app: 20, record: {"Customer Name": {value: "kintone Research"}}}'

Generating API Tokens

  1. Click the App Settings icon (the gear-shaped icon) at the upper right of the "View" screen.
    Screenshot: The "App Settings" icon is highlighted

  2. Select the App Settings tab in App Settings, then click API Token under Customization and Integration.

  3. On the "API Token" screen, click Generate.
    Screenshot: The "Generate" button

  4. For the generated API token, select the checkboxes under Permissions for the actions you want to allow. Screenshot: Check boxes for the actions you can allow

  5. If necessary, add notes for the API token by clicking the Edit icon for the Notes input field.
    You can use this field to enter information useful for managing the API token, such as the purpose of the API token or a contact person.
    Screenshot: "Notes" is outlined

    • You can enlarge the input field horizontally and/or vertically by dragging its lower right corner with your mouse.
    • You can enter up to 200 characters.
  6. Click the Save icon (the check mark) to save your notes.
    Screenshot: The "Save" button

  7. Click Save at the bottom right of the screen.

  8. Click Update App at the upper right of the screen.

  9. On the "Update App" dialog, click Update App.