API pública da Recipok e tokens de acesso
Plano Integral
Como criar e revogar os tokens da API, que dados se podem ler e escrever e onde está a documentação para o seu informático.
Para que serve
A API pública é a porta para que outro programa leia e escreva na sua conta da Recipok sem que ninguém copie dados à mão: a sua loja online que cria encomendas, o seu programa de gestão que recolhe as guias de remessa, uma folha de cálculo que consulta o stock todas as manhãs.
Cada programa entra com um token, uma chave longa que cria, entrega a quem faz a ligação e pode revogar quando quiser. Este artigo é para o dono que tem de criar essa chave e para o informático que a vai usar.
Antes de começar
- Os tokens fazem parte do plano Integral.
- São criados por um utilizador com a função de responsável ou administrador.
- Precisa de alguém que programe a ligação: quem mantém o seu programa de gestão ou o seu informático. Se não tiver ninguém, veja Ligue a Recipok à sua faturação, contabilidade ou POS: também fazemos integrações à medida.
Onde está
No menu da sua conta, no canto superior direito, entre em Integrações e abra o separador API Token. O ecrã Opções de desenvolvedor mostra a mesma informação; com um plano diferente do Integral apenas descreve a API e avisa que o seu plano não cria tokens.
1URL base da API: https://api.recipok.com · Cabeçalho de autenticação · Exemplo de pedido
Ver a documentação completa da API
| Nome | Estado | |
|---|---|---|
| Loja online | Armazenado com segurança | 2Remover |
Nome do token: Por exemplo: integração com o Zapier, desenvolvimento local, etc.
3Gerar token
- 1Os dados para o seu informático: o endereço da API, o cabeçalho onde vai o token e um exemplo pronto a copiar.
- 2Cada token tem nome: assim sabe que programa o usa e qual eliminar.
- 3Gerar token cria a chave e mostra-lha uma única vez.
Criar um token
Dê-lhe um nome
Em Criar novo token, escreva em Nome do token para que serve: «Loja online», «Contabilista», «Testes do informático». Um token por programa.
Carregue em Gerar token
Aparece o aviso Copia este token agora. Carregue em Cópia e guarde-o num local seguro ou envie-o diretamente a quem vai fazer a ligação.
Confirme
Ao carregar em confirme o token fica oculto para sempre. Na lista fica como «Armazenado com segurança»: a Recipok guarda-o cifrado e ninguém o pode voltar a ler.
Revogar tokens
- Para retirar uma chave, elimine-a em Os teus tokens com Remover. O programa que a usava deixa de entrar de imediato.
- O administrador vê também Tokens de outros utilizadores, com o respetivo proprietário, e pode usar Revogar token em qualquer um deles. É útil quando alguém sai da empresa.
Um token dá acesso aos dados da sua empresa. Não o cole em e-mails para várias pessoas nem em documentos partilhados, e crie um diferente para cada programa: assim pode cortar um sem parar os outros.
O que um programa pode fazer com a API
| Área | Exemplos |
|---|---|
| Receitas | Consultar receitas com os seus ingredientes, formatos, preços e IVA e informação nutricional. |
| Ingredientes e fornecedores | Ler e criar ingredientes; consultar fornecedores. |
| Compras e stock | Registar entradas de mercadoria e consultar ou ajustar o stock. |
| Produção | Criar ordens de produção, atribuir lotes e concluí-las. |
| Vendas | Criar pedidos de venda, marcá-los como entregues, registar saídas com os seus lotes e consultar ou criar clientes. |
| HACCP | Registar e consultar registos HACCP e localizações. |
Para o seu informático
- A documentação técnica completa está em api.recipok.com/api/doc (botão Ver a documentação completa da API). Pode ser lida em vários idiomas.
- A API responde no seu próprio domínio: os pedidos enviados para o endereço com que entra na Recipok não chegam até ela.
- O token vai no cabeçalho de autenticação indicado no ecrã, em cada pedido.
- Unidades imperiais, opcionais. Se a integração trabalhar em libras, onças ou graus Fahrenheit, pode pedi-lo com o cabeçalho X-Unit-System:
imperial_uk,us_customary,account(as unidades configuradas na sua conta) oumetric. Sem esse cabeçalho tudo continua no sistema métrico, como sempre.
Antes de ligar um programa novo à sua conta real, peça ao seu informático que teste com poucos dados e verifique na Recipok o que foi criado. As dúvidas sobre a API resolvem-se pelo chat de suporte.