このガイドでは、ConnectedCookingでREST APIを始める方法を簡単に説明します。本ガイドはConnectedCookingのクラウドREST APIソリューションのみを対象としています。
- まず、ConnectedCookingアカウントにAPIクライアントを作成する必要があります。そのため、ConnectedCookingアカウントの管理タブに移動します。
- 次にIntegrationsをクリックします。APIタブはアカウント管理者のみに表示されます。
- そして、"+ Add new "をクリックする。
- 次の図では、"ALIAS "を提供し、GROUPを割り当て、APIタイプを選択します。HACCPとConnectedCookingアカウントのデータに関するAPIクエリには、APIタイプ "Base API "が必要です。すべてのカラムを埋めたら、"APIを追加 "をクリックします。
- 次の画面で、APIクライアントの認証情報を受け取ります。安全な場所に保管し、閉じるをクリックしてください。
- APIクライアントを作成したら、それを使うためのツールが必要だ。そのためには、curlやPostman、あるいはあなたが知っている他のツールを使うことができる。このガイドではPostmanを使う。
- アプリケーションまたはウェブブラウザでPostmanを起動してください。それから+マークで新しい空白のコレクションを作成し、"Add a request "をクリックしてください。あるいは、"New "をクリックして新しいHTTPリクエストを作成することもできます。
- さらに、ConnectedCookingからAPIクライアントの認証情報を使用してBearer Tokenを受け取るために、新しく作成したリクエストをPOSTリクエストに編集する必要があります。
- そのため、APIドキュメントを確認する必要があります。認証｜ConnectedCooking ヘルプセンター
- ドキュメントには、さらにAPIリクエストを認証するためにBearer Tokenを作成する必要があると説明されている。
- これはPOSTリクエストによって実現される。POSTリクエストはエンドポイントを使用します：https://app.connectedcooking.com/api/auth/access
- さらに、リクエストのボディタブでContent-Type "x-www-form-urlencoded "を設定する必要があります。そして、API Clientからのユーザー名、パスワード、スコープを利用可能なカラムに挿入する必要があります。
- 最後に "Send "をクリックし、"accessToken = BearerToken "を受け取る。
- 新しく作成したBearerTokenを使用するには、それを使用するためのAPIが必要です。
- エンドポイントのドキュメントで、可能なすべてのAPIリクエストを簡単に確認できます：エンドポイント｜ConnectedCooking ヘルプセンター
- 例えば、デバイスリスト「Endpoint」を使ってみる。
- このリクエストはとても簡単で、"https://app.connectedcooking.com "を使い、"/api/public/devices "を追加し、POSTリクエストから "accessToken "をコピー・ペーストするだけです。Auth Typeで "Bearer Token "を選択すると、Tokenフィールドが表示されます。
- 最後に "Send "をクリックすると、ConnectedCookingアカウントに登録されているデバイスのリストが表示されます。
この例は基本的にすべてのエンドポイントに適用できる。
ConnectedCookingでREST APIが使えるようになりました！
追加情報が必要な場合は、ConnectedCookingのAPIドキュメントをご覧ください：はじめに｜ConnectedCooking ヘルプセンター
