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

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

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

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

cybozu.comの 動作環境の Web ブラウザー を使用します。

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

Postman のウェブサイト にアクセスし、Postmanのアカウントを取得しておきましょう。

まずはkintoneのアプリを作成しましょう。
kintoneのポータルから「＋」ボタンもしくは「アプリを作成」をクリックします。

「はじめから作成」をクリックして、新しくアプリを作成します。

アプリのフォームを設定する画面が表示されるので、「文字列（1行）」フィールドを配置しましょう。

配置したフィールドの右上にある歯車のボタンをクリックして「設定」に進みます。

設定画面でフィールドコードに「hello」と入力し、設定内容を保存します。

続いて、「設定」タブの「APIトークン」を開きます。

「生成する」ボタンをクリックし、APIトークンを生成します。

画面に表示されている「APIトークン」「アプリのID」は、あとでREST APIを実行する際に使用します。

アクセス権の「レコード追加」にチェックを入れ「保存」をクリックします。

ここまで作業ができたら、アプリを公開しましょう。

アプリのレコード一覧画面が表示されたら「＋」ボタンでレコードを作成します。

フィールドに「こんにちは、kintone!」と入力し、「保存」をクリックします。
以上でkintone上での作業は完了です。

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

Postmanにログインして「Create New」をクリックします。

「Create a request」で、新しいリクエストを作成します。

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

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

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

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

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

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

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

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

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

続いて「Body」タブでURLを入力し、Bodyの形式に「raw」を選択します。

最後に、kintoneへ登録するレコードの情報を赤枠のボックスに入力します。

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カスタマイズ チュートリアルでは、kintone REST APIのより詳細な使い方を学ぶことができます。
kintone カスタマイズ チュートリアル

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

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

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

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