この記事では、これからkintoneのカスタマイズを始める方に、kintone REST APIの「はじめの一歩」をお届けします。
kintone開発者ライセンスを取得したら、まずは本記事の内容にチャレンジしてみましょう。
本記事にしたがって実際に手を動かすことで、アプリの作成からkintone REST APIでkintoneを操作するまでの流れを体験できます。

Postmanを利用して、kintone REST APIでkintoneのレコードを取得／登録します。

本記事では、次の環境が必要になります。

kintone開発者ライセンスを取得済みの方は、すでにkintoneを利用可能です。
開発者ライセンスを未取得の方は、次のページから開発者ライセンスを申し込みましょう。
kintone開発者ライセンス（開発環境）

「サイボウズのクラウド基盤サイト」に掲載されているWebブラウザーを使用します。
動作環境のWebブラウザー

Postmanとは、Webブラウザー上のフォームに入力することで、REST APIを実行できるサービスです。

次のページからPostmanのアカウントを取得しておきましょう。
Postmanのウェブサイト

まずはkintoneのアプリを次の設定で作成しましょう。

アプリの作成方法はkintoneヘルプを参照してください。
アプリをはじめから作成する

続いて、APIトークンを次の手順で作成しましょう。

1. 「設定」タブの「APIトークン」を開きます。
2. 「生成する」ボタンをクリックし、APIトークンを生成します。
3. アクセス権の「レコード閲覧」「レコード追加」にチェックを入れ「保存」をクリックします。
4. 「アプリを更新」をクリックします。

「APIトークン」と「アプリのID」は、あとでREST APIを実行する際に使用します。

APIトークンの作成方法はkintoneヘルプを参照してください。
APIトークンを生成する

アプリのレコード一覧画面が表示されたら「＋」ボタンでレコードを作成します。
フィールドに「こんにちは、kintone!」と入力し、「保存」をクリックします。
以上でkintone上での作業は完了です。

アプリを作成できたら、実際にPostmanからkintone REST APIを使ってみましょう。

Postmanにログインして「Send an API request」をクリックします。

「Headers」タブの「KEY」と「VALUE」に、REST APIの実行に必要な認証情報を設定します。

「Params」タブに移動し、「Enter request URL」と書かれたボックスに「https://sample.cybozu.com/k/v1/record.json」と入力します。
「sample」の部分は、利用しているkintoneのサブドメインに置き換えてください。

続いて、「KEY」と「VALUE」に「アプリのID」と「レコードID」を設定します。
アプリのIDは、 APIトークン生成 時に確認した数字です。
また、今回はアプリに初めて登録したレコードを取得するので、レコードIDは「1」となります。

値を設定できたら「Send」をクリックし、REST APIを実行します。

レコード番号や作成者、フィールドの値といったレコードの情報を取得できました！

次はkintone REST APIでレコードを登録してみましょう。

Postmanの画面で「＋」ボタンをクリックし、新しいリクエスト画面を開きます。

「GET」を「POST」に変更します。

「Headers」タブに値を設定します。
今回は、レコード取得時に指定した「X-Cybozu-API-Token」に加えて、「Content-Type」を指定します。

続いて「Body」タブで レコードを取得する 時と同様のURLを入力し、Bodyの形式に「raw」を選択します。

最後に、kintoneへ登録するレコードの情報を赤枠のボックスに入力します。
「アプリのID」の部分は、利用しているkintoneのアプリのIDに置き換えてください。

1
2
3
4
5
6
7
8

{
    "app": "アプリのID",
    "record": {
        "hello": {
            "value": "はじめまして、kintone!"
        }
    }
}

入力が完了したら、「Send」をクリックしましょう。

追加したレコードのIDが表示されました。
また「status: 200 OK」が表示されており、APIの実行に成功したことがわかります。

kintoneのレコード一覧画面で、レコードが追加されていることを確認してみましょう！

kintone REST APIを利用すれば、他のシステムからkintoneを操作できます。
本記事の内容を終えたら、次はcybozu developer networkのコンテンツでkintone REST APIの知識をさらに深めましょう！

「GETとはなんだろう？」「設定したKEYとVALUEにはどんな意味があるの？」といった疑問を解消できるはずです。

チュートリアルでは、kintone REST APIのより詳細な使い方を学ぶことができます。
kintone REST APIを使ってみよう

kintone APIドキュメントでは、kintone REST APIの仕様を確認できます。
kintone REST API

また、kintone APIによるさまざまなカスタマイズ事例を紹介したTipsもあります。
kintoneカスタマイズTips

TipsはチュートリアルやAPIドキュメントで深めた知識を前提とし、実務につながる気付きやノウハウを得られる応用的な内容となっています。

このTipsは、2025年6月版kintoneで動作を確認しています。