狠狠撸

kintone devCamp Vol.11
REST API ハンズオン初級編
2017年3月1日

自己紹介
会社：サイボウズ株式会社
名前：竹内能彦（たけうちよしひこ）
年齢： 33歳
出身：香川県坂出市

やること
? kintone REST APIのデモ
? ハンズオン
? 問い合わせアプリの作成
? データの登録
? REST API（データの取得（1件））
? フリータイム
? REST APIもっと試す
? 自分に必要なアプリを作ってみる

? 外部からkintoneのデータ取得（kViewer）
? 外部からkintoneにデータ登録（考え中）
? 応用）kintoneからREST API（郵便番号から住所取得）

运用イメージをデモで绍介

? kintone環境 https://xxxx.cybozu.com/ に移動
? ログイン名、パスワードを入力し、ログイン

? アプリ横の「+」をクリック

? 「はじめから作成」をクリック

問い合わせアプリの作成でやること
Step.1 アプリ名を決める
Step.2 データベースの構成を決める
Step.3 一覧画面に表示する项目を选択する

? アプリ名を適当に入力（例では「問い合わせ管理」）

? 「文字列（1行）」をドラッグ＆ドロップ
ドラッグ&
ドロップ

? 「歯車」にフォーカスを合わせて、「設定」をクリック

? 「フィールド名」を「会社名」に変更
? 「フィールドコード」を「company」に変更
? 「必須項目にする」にチェック
? 「保存」をクリック
フィールドコードはAPIでのデータ取得や登録に必要。
APIを利用するときは半角英数で設定するのがお勧め。

設定後の画面
? こんな感じになってたらOK！

残り7つのフィールドを設定
フィールドタイプフィールド名
フィールド
コード
必須備考
1 文字列（1行）会社名 company 〇
2 作成日時
3 文字列（1行）部署名 division
4 文字列（1行）お名前 name 〇
5 リンクメールアドレス mail 〇入力値の種類に
メールアドレスを選択
6 リンク電話番号 tel 入力値の種類に
電話番号を選択
7 ドロップダウン問い合わせ内容 category 〇選択肢は「サービス内容、
要望、その他」を設定
8 文字列（複数行）詳細 memo 〇

設定後の画面
? こんな感じになっていたらOK！
場所や並び順はこの通りでなくても大丈夫。
早くできた人は↓にチャレンジ！
?横枠を長くして入力しやすくする
?ドラッグ＆ドロップで並び順を変更する

? 「フォームを保存」をクリック

一覧画面に表示する項目を決めます
? 「一覧」をクリックして、「+」をクリック

? 一覧名を適当に入力（例では「問い合わせ一覧」）
? 一覧画面に表示したいフィールドをドラッグ＆ドロップ
ドラッグ&
ドロップ

? 「アプリを公開」をクリックして、「OK」をクリック

? 「+」をクリックして、データ登録画面に遷移

? 適当に入力して、「保存」をクリック

一覧画面に遷移
左から
? 追加
? 編集
? 複製
? その他の操作
（アプリ設定はここから）
残り2件（合計3件）のデータを登録
※問い合わせ内容は様々なデータを選択

準備1 Postmanのインストール
? Google Chromeを起動
? 左上の「アプリ」をクリック
? 「ウェブストア」をクリック

? 「postman」で検索
? 「ADD TO CHROME」をクリック

? 左上の「アプリ」をクリック
? 「Postman」をクリック

? 「Skip this, go straight to the app」をクリック

? この画面が表示されればPostman利用の準備は完了

準備2 アプリIDの確認
? アプリを開く
? URLからアプリIDを確認（要メモ）
「/k/xxx/」の「xxx」がアプリID

レコードの取得（1件）

? https://cybozudev.zendesk.com/に移動し、ブックマーク
（「kintone developer」で検索してもOK）
? 「APIドキュメント?ツール」をクリック
? 「kintone REST API」をクリック

? 「レコード」をクリック
? 「レコードの取得（GET）」をクリック
? 「レコードの取得（1件）」をクリック

リクエストに必要な情報を確認
どのアプリのどのデータ
1件
データを取得したい

リクエストの作成
? メソッドは「GET」を選択
? URIは
「https://xx.cybozu.com/k/v1/record.json?app=x&id=xx」
? 「Send」をクリック
app=xの「x」には先ほど確認したアプリIDを指定
id=xxの「xx」には取得したいデータのレコード番号を指定
パラメータはURIの後に「?」で繋ぎ、
パラメータは「&」で繋ぐ

レコードの取得は失敗するけど、一応成功
? 「ログインしてください。」というメッセージが表示されれば
成功
認証が必要

kintone REST API の認証
? 下記いずれかの認証が必要
パスワード認証トークン認証
認証情報
「ログイン名:パスワード」を
BASE64エンコード
APIトークン
認証情報の付加場所リクエストヘッダ
利用可能な API 全部一部
どのユーザーでの操作「ログイン名」で指定したユーザー Administrator
注意事項セキュアアクセス環境からは利用できない

础笔滨トークンの生成

? 「???」をクリック
? 「アプリの設定を変更」をクリック

? 「API トークン」をクリック

? 「生成する」をクリック
? 「レコード閲覧」、「レコード追加」にチェック
? 「APIトークン」をメモ帳にコピーし、「保存」をクリック
メモ帳にコピー

? 「アプリを更新」をクリックして、「OK」をクリック

础笔滨トークンの指定方法

? 「共通仕様」をクリック
? 「REST APIの共通仕様」をクリック
? 「ユーザー認証」をクリック

kintone dev camp vol.11 kintone rest api ハンズオン初級編

APIトークンをHeadersにセット
? 「Headers」タブを選択
? Keyには「X-Cybozu-API-Token」を指定
? Valueには先ほどコピーしたAPIトークンを指定
? 「Send」をクリック

成功
? データの内容が表示されている事を確認

ここからはチームごとにやることを選択
? REST APIもっと試すチーム
→ レコードの取得（复数件） PXX～
→ レコードの登録（1件） PXX～
? 自分に必要なアプリを作ってみるチーム
→ アプリ作成（エクセルやアプリストアからも作れます）
→ データ登録して、グラフを作成
→ モバイルから確認チーム内で別れてもOK！
チーム内でわからなければ挙手してや
資料あり
資料なし

レコードの取得（复数件）

? レコードの取得をクリック
? レコードの一括取得（クエリで条件を指定）をクリック

リクエストに必要な情報の確認
複数件
※1件の場合はrecord.json
※複数件の場合はrecords.json
データを取得したい

どのアプリのどんなデータ

今回は問い合わせ内容
（ドロップダウン）を条件に指定

? メソッドは「GET」を選択
? URIは「https://xxxx.cybozu.com/k/v1/records.json?
app=x&query=category in (”XXX”)」
?Sendをクリック
1件取得はrecord.json
一括取得はrecords.json
queryの内容意味
app=x アプリID がx
query=rank in (”XXX”) category（問い合わせ内容）がXXXのデータ

成功
? 対象となる件数分のデータが取得できたことを確認

レコードの登録（1件）

? 「レコード」をクリック
? 「レコードの登録（POST）」をクリック
? 「レコードの登録（1件）」をクリック

1件
データを登録したい

リクエストに必要な情報を確認
どのアプリに、どんなデータ

kintone REST APIのボディの構造を確認
どんなデータ

REST APIのデータの渡し方は2種類
1. URIにパラメータ情報をセット
2. BODYにパラメータ情報をセット
項目内容
URI URI + ’?’ + パラメータ
BODY 空
項目内容
URI URI
BODY パラメータ
データの取得（GET）はこちら
データの登録や更新
（POST、PUT）はこちら

今回登録する項目
? 赤文字（必須項目）を登録
フィールドタイプフィールド名
フィールド
コード
必須備考
1 文字列（1行）会社名 company 〇
2 作成日時
3 文字列（1行）部署名 division
4 文字列（1行）お名前 name 〇
5 リンクメールアドレス mail 〇入力値の種類に
メールアドレスを選択
6 リンク電話番号 tel 入力値の種類に
電話番号を選択
7 ドロップダウン問い合わせ内容 category 〇選択肢は「サービス内容、要
望、その他」を設定
8 文字列（複数行）詳細 memo 〇

データの形式を確認
? リクエストプロパティのフィールド形式をクリック

ドロップダウンの构造

文字列（复数行）の构造

? メソッドは「POST」を選択
? URIは「https://xxxx.cybozu.com/k/v1/record.json」
? 「Body」タブを選択
? 項目は「raw」を選択

? 入力欄にBODYの内容を入力
? Sendをクリック

参考）Bodyに記入する内容
{
"app": xxx,
"record": {
"company": {
"value": "サイボウズ株式会社"
},
"name": {
"value": "竹内能彦"
},
"mail": {
"value": "yoshihiko-takeuchi@cybozu.co.jp"
},
"category": {
"value": "その他"
},
"memo": {
"value": "1行目n2行目"
}
}
}

失敗
? 以下のメッセージが表示されれば成功
（レコードの登録自体は失敗なのですが???）
BODYのデータ形式を指定する必要がある

データ形式の指定
? REST APIの「共通仕様」をクリック
? 「REST APIの共通仕様」をクリック
? 「リクエストヘッダ」をクリック

リクエストヘッダに必要な情报を确认

? 「Headers」タブを選択
? 項目には「Content-Type」を指定
? 値には「application/json」を指定
? Sendをクリック
「BODY」タブで「JSON」を選択してもOK

成功
? レコード番号とrevisionが返されることを確認
? アプリにデータが追加されていることを確認

以上になります。
ありがとうございました。

狠狠撸

kintone dev camp vol.11 kintone rest api ハンズオン初級編

More Related Content

kintone dev camp vol.11 kintone rest api ハンズオン初級編