カテゴリー内の他の記事

kintone REST API を Postman で実行してみよう

Index

はじめに

この記事では、これから kintone のカスタマイズを始める方に、kintone REST API の「はじめの一歩」をお届けします。

kintone 開発者ライセンスを取得したら、まずは本記事の内容にチャレンジしてみましょう。

本記事に従って実際に手を動かすことで、アプリの作成から kintone REST API で kintone を操作するまでの流れを体験することができます。

カスタマイズの内容

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

必要なもの

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

kintone

kintone 開発者ライセンスを取得済みの方は、すでに kintone を利用可能です。

開発者ライセンスを未取得の方は、kintone 開発者ライセンス(開発環境)のページから開発者ライセンスを申し込みましょう。

Webブラウザ

cybozu.com の推奨ブラウザを使用します。

Postman

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

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

REST API を使ってみる

アプリを作成する

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

100.png

 

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

110.png

 

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

120.png

 

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

125.png

 

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

130.png

 

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

131.png

 

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

132.png

 

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

134.png

 

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

133.png

 

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

140.png

 

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

150.png

 

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

160.png

 

レコードを取得する

アプリを作成することができたら、実際に Postman から kintone REST API を使ってみましょう。Postman にログインして「Create New」をクリックします。

001.png

 

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

010.png

 

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

012.png

入力する値

KEY VALUE
X-Cybozu-API-Token kintone で生成した API トークン

 

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

013.png

 

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

014.png

入力する値

KEY VALUE
app アプリの ID
id レコード ID

 

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

015.png

 

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

016.png

レコードを登録する

次は kintone REST API でレコードを登録してみましょう。Postman の画面で「+」ボタンをクリックし、新しいリクエスト画面を開きます。

020.png

 

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

021.png

 

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

022.png

入力する値

KEY VALUE
X-Cybozu-API-Token kintone で生成した API トークン
Content-Type application/json

 

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

025.png

 

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

026.png

入力する値

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

027.png

 

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

028.png

 

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

029.png

おわりに

kintone REST API を利用すれば、他のシステムから kintone を操作することができるようになります。

本記事の内容を終えたら、次は cybozu developer network のコンテンツで kintone REST API の知識をさらに深めましょう!

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

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

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

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

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

この記事は、2021年3月版 kintoneで確認したものになります。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。