O Toast é um dos sistemas de Ponto de Venda mais comuns na América do Norte. Neste artigo, explicaremos como configurar a integração da API entre o seu sistema Toast e o OptiSigns.
- Etapa 1: Preparação
- Etapa 2: Autenticação na API do Toast
- Etapa 3: Chamar a API para obter os dados necessários do Toast
- Etapa 4: Criar o DMB Designer com OptiSync
O Toast fornece uma API para os utilizadores integrarem os dados do POS com outros sistemas. Com o OptiSync, criar menus digitais com atualização automática a partir dos dados da sua API do Toast é simples.
A API do Toast requer um token de autenticação gerado dinamicamente que deve ser fornecido com cada chamada da API, ao contrário de muitos outros sistemas POS que utilizam uma chave de API estática. Isto adiciona alguma complexidade à integração que outros sistemas POS não têm. No entanto, usando a requisição de API do OptiSigns e o OptiSync, estas complexidades adicionais não são problema algum.
Neste artigo, forneceremos um guia passo a passo sobre como integrar a sua API do Toast usando a requisição de API do OptiSigns, e como criar um DMB usando o OptiSync. Abaixo estão os passos de alto nível que seguiremos:
1. Obter informações necessárias do portal Toast
2. Obter o Token de Autenticação do Toast (Dentro da etapa de Pré-Requisição)
3. Chamar a API para obter os dados necessários do Toast
4. Usar os dados da API do Toast para criar DMB no designer com OptiSync
Etapa 1: Preparação
Para começar a integração de uma API do Toast com o OptiSigns, precisamos das seguintes informações do sistema Toast:
- toast-api-hostname
- clientId
- clientSecret
- userAccessType
Consulte a Documentação do Toast aqui para mais detalhes.
| NOTA |
| Para usar a API do Toast para ler dados, é necessário acesso à API Padrão do Toast. Isto geralmente tem um custo adicional (para o Toast) de $25/mês por localização. |
Etapa 2: Autenticação para a API do Toast
Para a autenticação da API do Toast, primeiro precisaremos passar a requisição POST para obter o token de autenticação. O token de autenticação é então usado para passar na requisição da API para obter os dados dos menus, pedidos, etc. do Toast.
Este processo de autenticação será tratado usando o processamento de Pré-requisição com a requisição de API do OptiSigns. Para mais informações sobre o processamento de Pré-requisição e requisições de API em geral, consulte aqui.
Na etapa de processamento de Pré-requisição, a API do OptiSigns chama a API de autenticação para obter o token necessário e define-o no contexto da requisição da API.
Neste exemplo, o token é definido para a variável de contexto "authorization". Quando a requisição da API é feita, ela será capaz de usar o token de autenticação. Abaixo está uma captura de ecrã deste exemplo na prática.
Use este snippet de código (com os dados obtidos anteriormente preenchendo os "xxx") para
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));
Etapa 3: Chamar a API para obter os dados necessários do Toast
Agora vamos usar o token de autorização que recebemos no processamento de Pré-requisição e passá-lo para o cabeçalho da chamada da API real.
No separador Cabeçalho, crie dois parâmetros com os seguintes valores:
authorization Bearer {{authorization}}
Toast-Restaurant-External-ID
Pode obter o valor Toast-Restaurant-External-ID no Portal Toast. Este é o ID do restaurante específico do qual deseja obter dados.
Agora coloque o URL da API desejado do qual deseja obter dados. Neste exemplo, usámos a seguinte API para obter os menus
A requisição final será algo como isto:
Pode ativar esta requisição e guardar a API. Clique em Executar Teste.
Deverá receber uma resposta (200 OK), com dados a retornar da API. Isto significa que a requisição da API contactou com sucesso o Toast e está a transferir dados.
Etapa 4: Criar Menu Digital no Designer com OptiSync
Agora que a sua fonte de dados de requisição de API está pronta para uso, pode criar o seu DMB usando o Designer com OptiSync. O OptiSync permite-lhe mapear os dados da API para um elemento no designer, seja texto ou imagens. Usando Repetidores, estes dados podem ser usados para construir menus de múltiplos itens, e também pode definir como gostaria de lidar com itens esgotados, especiais e mais.
Para um guia passo a passo e mais exemplos, consulte o nosso artigo sobre Criar Menus Digitais Usando OptiSync.
É tudo!
Recuperou com sucesso os dados do Toast e exibiu-os nos ecrãs usando o OptiSigns.