外部公開APIを作成する

外部公開APIとは、外部に公開できる、kintoneのデータを参照するためのAPIになります。フォームブリッジの「kViewerルックアップ」や、JavaScriptでのカスタマイズに使います。

注意
アクセス制限をかけていない場合、外部公開APIはURLにアクセスすると、公開した全ての情報を閲覧することができます。
個人情報などを扱う場合は Toyokumo kintoneApp認証を使用した絞り込み条件を設定してご利用ください。
補足
  • フォームブリッジ側の設定に関しては、kViewerルックアップを設定するを参照してください。
  • 外部公開APIを作成した際のURLは、データを参照させるためのものとなり、このURLを公開することは想定しておりません。
    kViewerルックアップで公開するデータを確認するためには、フォームブリッジ側でkViewerルックアップの設定を行う必要があります。

設定方法

1.マスタとなるアプリを作成します。


2.kViewerにログインします。
『ビューの作成』に進みます。


3.外部公開APIの[作成]を押します。


4.ビューの管理名とkintoneアプリのURLを登録します。
kintoneアプリのURLは、アプリを開いた画面に表示されている
https://(サブドメイン).cybozu.com/k/xxx/の形式のURLです。
その後、”APIトークンはこちらのURLから生成できます。”をクリックします。


5.APIトークンの生成画面で、[生成する]をクリックします。


6.APIトークンは「レコード閲覧」のアクセス権が必要です。
APIトークンをコピーして、[保存]→[アプリを更新]まで行います。


7.kViewerの画面に戻り、コピーしたAPIトークンを貼り付け、[作成]ボタンをクリック押します。


8.『公開情報』の「kintoneフィールド」から、kViewerルックアップで検索した際に取得するフィールドを選択します。


9.「1リクエストでの取得数」では、kViewerルックアップで検索した際に表示するマスターの1ページの件数を指定できます。
[保存]します。


10.ユーザー管理(プレミアムコース以上)によって外部公開APIへのアクセス制限をかけることができます。


11.マスタデータの絞り込みを行う場合は、『レコードの絞り込み/並び順』から設定します。設定方法はレコードの絞り込み/並び順をご参照ください。


12.[公開]をクリックし、公開したら設定は完了です。

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です