メインコンテンツへスキップ

APIを実行したい

サポート担当者
更新

「Convi.BASE Public API」画面上で、APIの利用方法を確認することができます。
APIを利用するには事前にアクセストークンの発行が必要です。
ここではAPIの実行方法を説明します。

 

①Convi.BASE Public API 画面から「Authorize」をクリックします。
API_9.png

②「アクセストークンを発行したい」にて発行したアクセストークンを「Value」に入力し、「Authorize」をクリックします。
API_10.png

③設定が完了したら、「Close」をクリックします。
API_11.png

④「Authorize」ボタンの鍵マークがロックされます。
2022-06-22_10h26_09.png

⑤確認したいAPIをクリックします。（ここでは「ビュー内データの閲覧」をクリックします）
2022-06-22_10h27_14.png

⑥「Try it out」をクリックします。
2022-06-22_10h27_28.png

⑦パラメーター（parameters)にデータを表示したいビューの情報を入力し、「Execute」をクリックします。(パラメーターについては「APIに何のパラメーターを指定したらよいか知りたい」を参考にしてください）

2022-06-22_10h27_44.png

⑧「Curl」に作成されたAPIが表示されます。パラメータから作成されたURLは「Request URL」に表示されます。
2022-06-22_10h29_17.png

⑨「Response body」に取得できる情報が表示されます。右下の「Download」を押すと「Response body」の内容をダウンロードできます。
2022-06-22_10h36_41.png

 

※ 注意
表示されるデータ最大件数は 100 件です。次の 100 件を取得する場合はブラウザー同様page=2を
パラメーターに付加してしてください。

例：「Request URL」部分に２ページ目を付加する。
https://xxxxxx.cbee.jp/cbee-html/api/v2/app/1/view/33
                 ↓
https://xxxxxx.cbee.jp/cbee-html/api/v2/app/1/view/33?page=2

 

上記で、Convi.BASE Public API からAPIを利用できます。

 

関連記事

コメント

0件のコメント

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