Toastは北米で最も一般的なPOSシステムの1つです。この記事では、ToastシステムとOptiSigns間のAPI統合の設定方法について説明します。
Toastは、POSデータを他のシステムと統合するためのAPIを提供しています。OptiSyncを使用すると、Toast APIのデータから自動更新されるデジタルメニューボードを簡単に構築できます。
Toast APIは、静的なAPIキーを使用する他の多くのPOSシステムとは異なり、すべてのAPI呼び出しで動的に生成される認証トークンを提供する必要があります。これにより、他のPOSシステムにはない統合の複雑さが追加されます。しかし、OptiSignsのAPIリクエストとOptiSyncを使用すれば、これらの追加の複雑さは全く問題ありません。
この記事では、OptiSigns APIリクエストを使用してToast APIを統合する方法と、OptiSyncを使用してDMBを作成する方法について、ステップバイステップのガイドを提供します。以下は、私たちが従う高レベルのステップです:
1. Toastポータルから必要な情報を取得する
2. Toastから認証トークンを取得する(Pre-Requestステップ内)
3. APIを呼び出してToastから必要なデータを取得する
4. Toast APIデータを使用してOptiSyncでデザイナーにDMBを構築する
ステップ1:準備
Toast APIとOptiSignsの統合を開始するには、Toastシステムから次の情報が必要です:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
詳細については、Toastのドキュメントこちらを参照してください。
| 注意 |
| ToastのAPIを使用してデータを読み取るには、Toast Standard APIアクセスが必要です。これには通常、ロケーションごとに月額25ドルの追加料金(Toastへの支払い)が発生します。 |
ステップ2:Toast APIの認証
Toast API認証では、まず認証トークンを取得するためにPOSTリクエストを渡す必要があります。認証トークンは、Toastのメニュー、注文などからデータを取得するためのAPIリクエストに渡すために使用されます。
この認証プロセスは、OptiSignsのAPIリクエストのPre-request処理を使用して処理されます。Pre-request処理とAPIリクエスト全般の詳細については、こちらをご確認ください。
Pre-request処理段階では、OptiSigns APIが認証APIを呼び出して必要なトークンを取得し、APIリクエストのコンテキストに設定します。
この例では、トークンはコンテキスト変数「authorization」に設定されています。APIリクエストが行われると、認証トークンを使用できるようになります。以下は、この例の実践のスクリーンショットです。
このコードスニペットを使用します(先ほど取得したデータで「xxx」を埋めてください):
const body = {
"clientId": "xxx",
"clientSecret": "xxx",
"userAccessType": "xxx"
};
const {data, headers} = await os.postRequest("https://[toast-api-hostname]/authentication/v1/authentication/login", body );
const token = os.getValue(data.token.accessToken);
os.context.set("authorization", os.getValue(token));
ステップ3:APIを呼び出してToastから必要なデータを取得する
次に、Pre-request処理で受け取った認証トークンを使用して、実際のAPI呼び出しヘッダーに渡します。
Headerタブで、次の値を持つ2つのパラメータを作成します:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
Toast-Restaurant-External-ID値はToastポータルから取得できます。これは、データを取得したい特定のレストランIDです。
次に、データを取得したい目的のAPI URLを入力します。この例では、メニューを取得するために次のAPIを使用しました:
最終的なリクエストは次のようになります:
このリクエストを有効にしてAPIを保存できます。テストを実行をクリックします。
APIからデータが返され、(200 OK)レスポンスを受け取るはずです。これは、APIリクエストがToastに正常に接続し、データを転送していることを意味します。
ステップ4:OptiSyncを使用してデザイナーでデジタルメニューボードを構築する
APIリクエストデータソースが使用可能になったので、OptiSyncを使用してデザイナーでDMBを構築できます。OptiSyncを使用すると、APIデータをテキストまたは画像のいずれかのデザイナー内の要素にマッピングできます。リピーターを使用することで、このデータを使用して複数のアイテムメニューを構築でき、売り切れアイテム、スペシャルなどの処理方法も定義できます。
ステップバイステップガイドとその他の例については、OptiSyncを使用したデジタルメニューボードの構築に関する記事をご覧ください。
以上です!
Toastからデータを正常に取得し、OptiSignsを使用して画面に表示しました。