kintonのAPIを叩いて取得したデータをサイトに反映 といった感じのものをやりたい。
テスト用アプリは作成済。
ということで、作成したアプリの組み方が問題ないか、サイト側の対応はどのようなものでよいか、の確認のために実際返ってくるjson形式を調べます。
phpコードを書いて。。うんぬんは後日やるので、まずは手軽に確認するためにpostmanを使ってみました。
ここを見ながら作業します(というか答えはここに書いてある)
https://developer.cybozu.io/hc/ja/articles/360028177472
##GET レコードの取得
###1.レコードを一括取得
・URI
https://(サブドメイン名).cybozu.comk/v1/records.json/k/v1/records.json
※サブドメイン名は自分の使用しているもの。わからなかったらデータを取りに行きたいアプリ画面のURIを見る。
一件とるだけなら/k/v1/record.json
・必要なアクセス権
アプリのレコード閲覧権限
値を取得するレコードの閲覧権限
値を取得するフィールドの閲覧権限
※アプリ側のアクセス権の設定が必要なので、設定していない場合はまずそちらを設定する。
↓アクセス件の設定
https://jp.cybozu.help/k/ja/user/app_settings/rights/app_rights.html
・リクエストパラメータ
app アプリのID を指定 (※必須)
※わからなかったらデータを取りに行きたいアプリ画面のURIをみる
・リクエストヘッダ
ユーザー認証のためのヘッダ
X-Cybozu-Authorization :「ログイン名:パスワード」をBASE64エンコードしたものを値に指定
※ログイン名が「Administrator」、パスワードが「cybozu」の場合
X-Cybozu-Authorization:QWRtaW5pc3RyYXRvcjpjeWJvenU=
これらの情報が準備できたら、postmanの画面で入力していきます。
↓こんな感じ
chrom拡張機能を使ってます
https://chrome.google.com/webstore/detail/tabbed-postman-rest-clien/coohjcphdfgbiolnekdpbcijmhambjff
###2.ソートさせて一括取得
リクエストパラメータを追加することでソートができます。というかその他もお望みのまま。
「query」パラメータを使ってフィールドコードを指定してソートさせます。
↓アプリ側のフィールドコードの設定
https://jp.cybozu.help/k/ja/user/app_settings/form/autocalc/fieldcode.html
今回は簡単にフィールドコード「sort」を昇順で並べ替えしました。
###注意点
・一度に取得できるレコードは 500件まで。 ※2020年1月時点
・今回のアプリではサブテーブルにある値でのソートはできなかった
## 感想
まずは簡単にjson形式を調べたかったらこれだけでいいのか。。。と理解。
postman全然触ったことなかったんですが、今回のようなちょっとしたことを試すだけでもすごく便利でした。
パラメータやヘッダの追加もミスなく簡単にできる。
ここには記載してないのですが、kintoneのアプリ作成もすごく簡単にできたので感動でした。
引用元:
パラメータ表のスクリーンショットなど
https://developer.cybozu.io/hc/ja/articles/360028177472