A funcionalidade de External API da Plataforma IOK permite integrar seus equipamentos, menus, receitas e dados operacionais com sistemas externos, ERPs, dashboards, aplicações próprias, plataformas de BI e outras soluções desenvolvidas pela sua empresa.

Com ela, é possível automatizar processos, consumir dados da plataforma em tempo real e até conectar equipamentos diretamente via API, dependendo da necessidade da operação.

Pré-requisitos

Antes de utilizar os recursos de API, é necessário:

1. Possuir uma conta ativa na Plataforma IOK
2. Estar vinculado a uma empresa na plataforma
3. Ter acesso aos equipamentos e menus que deseja utilizar

Caso ainda não possua acesso:

• Saiba como criar uma conta:
  Plataforma IOK - Aba Login
• Saiba como convidar usuários para uma empresa existente:
  Plataforma IOK - Aba Usuários

Recomendação importante

Para aproveitar melhor os recursos da API, recomendamos que sua conta já possua:

• Equipamentos cadastrados
• Menus criados
• Grupos e receitas configurados

Artigos relacionados:

• Equipamentos:
  Plataforma IOK - Aba Equipamentos
• Menus:
  Plataforma IOK - Aba Meus Menus

Observação:
Também é possível conectar equipamentos diretamente à Plataforma IOK utilizando a própria API.

Como habilitar o modo Desenvolvedor e gerar o Token

Após realizar login na Plataforma IOK:

1. Clique no seu nome de usuário no canto superior direito
2. Selecione a opção "Editar Conta"
3. Clique em "Token Desenvolvedor"

Será exibida uma janela solicitando a senha atual da plataforma.

4. Digite sua senha
5. Clique em "Confirmar"

Após a confirmação, o modo Desenvolvedor será habilitado e um Token de Desenvolvedor será gerado.

Importante:
Esse token é utilizado para autenticar as requisições realizadas via API. Recomendamos mantê-lo em segurança e não compartilhá-lo com terceiros.

Copiando o Token de Desenvolvedor

Depois da geração:

1. Copie o token exibido na tela
2. Utilize esse token nas autenticações das requisições da API

Esse token deverá ser enviado nos headers das chamadas realizadas para os endpoints da plataforma.

Acessando a documentação da API

Após habilitar o modo Desenvolvedor, uma nova opção chamada "API Externa" será exibida no menu lateral da Plataforma IOK.

Ao acessar essa opção, você será direcionado para a documentação interativa da API.

Nessa página é possível:

• Visualizar todos os endpoints disponíveis
• Entender os parâmetros de cada requisição
• Consultar exemplos de payloads
• Testar requisições diretamente pelo navegador
• Validar integrações antes da implementação final

Como autenticar as requisições

Na documentação da API:

1. Clique no botão "Authorize"
2. Insira o Token de Desenvolvedor
3. Confirme a autenticação

Após isso, as requisições realizadas dentro da documentação já utilizarão automaticamente o token informado.

Consultando equipamentos conectados

Caso deseje trabalhar com dados dos equipamentos conectados à sua conta, o endpoint abaixo é um dos mais importantes:

GET /equipmentList

Ele retorna a lista de equipamentos vinculados à empresa, incluindo seus respectivos IDs.

Os IDs dos equipamentos são utilizados em diversos endpoints da API.

Como encontrar o ID de um equipamento

Além do endpoint GET /equipmentList, também é possível localizar o ID diretamente pela plataforma:

1. Acesse a guia "Equipamentos"
2. Selecione o equipamento desejado
3. Abra o dashboard individual do equipamento

O ID será exibido nas informações do equipamento.

Exemplos de utilização da API

Com a External API da Plataforma IOK, sua empresa pode:

• Integrar equipamentos com sistemas próprios
• Automatizar envio de menus e receitas
• Desenvolver dashboards personalizados
• Criar integrações com ERPs e CRMs
• Monitorar telemetria e eventos
• Automatizar atualizações de software
• Consolidar dados operacionais em ferramentas de BI
• Desenvolver aplicações customizadas para operação

Observações importantes

• Cada token possui limite de requisições por minuto
• O token é individual e vinculado à conta do usuário
• Recomendamos que integrações sejam desenvolvidas por profissionais da área de tecnologia
• Algumas funcionalidades podem variar conforme o modelo do equipamento

Precisa de ajuda?

Caso tenha dúvidas sobre integrações ou utilização da External API da Plataforma IOK, entre em contato com nosso time de suporte através dos canais oficiais de atendimento da Prática.