Salta al contingut
Recipok Centre d'ajuda

API pública de Recipok i tokens d’accés

Pla Integral

Com crear i revocar els tokens de l’API, quines dades es poden llegir i escriure i on és la documentació per al teu informàtic.

Per a què serveix

L'API pública és la porta perquè un altre programa llegeixi i escrigui al teu compte de Recipok sense que ningú copiï dades a mà: la teva botiga en línia que crea comandes, el teu programa de gestió que recull els albarans, un full de càlcul que consulta l'estoc cada matí.

Cada programa entra amb un token, una clau llarga que tu crees, dones a qui fa la connexió i pots revocar quan vulguis. Aquest article és per al propietari que ha de crear aquesta clau i per a l'informàtic que la farà servir.

Abans de començar

  • Els tokens formen part del pla Integral.
  • Els crea un usuari amb rol d'encarregat o administrador.
  • Necessites algú que programi la connexió: qui et manté el programa de gestió o el teu informàtic. Si no en tens, consulta Connecta Recipok amb la teva facturació, comptabilitat o TPV: també fem integracions a mida.

On és

Al menú del teu compte, a dalt a la dreta, entra a Integracions i obre la pestanya API Token. La pantalla Opcions de desenvolupador mostra la mateixa informació; amb un pla diferent de l'Integral només descriu l'API i avisa que el teu pla no crea tokens.

Integracions › API Token
DobboxHoldedAPI Token
Integració amb API

1URL base de l'API: https://api.recipok.com · Capçalera d'autenticació · Exemple de petició

Veure documentació completa de l'API

Els teus tokens
NomEstat
Botiga en líniaDesat de forma segura2Elimina
Crea un nou token

Nom del token: Ex: Integració Zapier, Desenvolupament local, etc.

3Genera token

La pestanya API Token de Pastelería La Plaza, amb un token creat per a la seva botiga en línia.
  1. 1Les dades per al teu informàtic: l'adreça de l'API, la capçalera on va el token i un exemple a punt per copiar.
  2. 2Cada token té nom: així saps quin programa el fa servir i quin has d'esborrar.
  3. 3Genera token crea la clau i te l'ensenya una sola vegada.

Crear un token

1

Posa-li un nom

A Crea un nou token, escriu a Nom del token per a què és: «Botiga en línia», «Gestoria», «Proves de l'informàtic». Un token per programa.

2

Prem Genera token

Apareix l'avís Copia aquest token ara. Prem Copia i guarda'l en un lloc segur o envia'l directament a qui farà la connexió.

3

Confirma

Quan prems Confirma, el token s'amaga per sempre. A la llista queda com a «Desat de forma segura»: Recipok el desa xifrat i ningú no el pot tornar a llegir.

Fixa-t'hiSi tanques sense copiar-lo, no passa res greu: esborra'l i genera'n un altre.

Revocar tokens

  • Per retirar una clau, esborra-la des d'Els teus tokens amb Elimina. El programa que la feia servir deixa d'entrar a l'instant.
  • L'administrador veu, a més, Tokens d'altres usuaris, amb el seu propietari, i pot fer servir Revoca el token en qualsevol d'ells. És útil quan algú deixa l'empresa.
Important

Un token dona accés a les dades de la teva empresa. No l'enganxis en correus a diverses persones ni en documents compartits, i crea'n un de diferent per a cada programa: així en pots tallar un sense aturar els altres.

Què pot fer un programa amb l'API

ÀreaExemples
ReceptesConsultar receptes amb els seus ingredients, formats, preus i IVA i la informació nutricional.
Ingredients i proveïdorsLlegir i donar d'alta ingredients; consultar proveïdors.
Compres i estocRegistrar entrades de mercaderia i consultar o ajustar l'estoc.
ProduccióCrear parts de producció, assignar lots i finalitzar-los.
VendesCrear comandes de venda, marcar-les com a lliurades, registrar sortides amb els seus lots i consultar o crear clients.
APPCCRegistrar i consultar registres APPCC i ubicacions.

Per al teu informàtic

  • La documentació tècnica completa és a api.recipok.com/api/doc (botó Veure documentació completa de l'API). Es pot llegir en diversos idiomes.
  • L'API respon al seu propi domini: les peticions enviades a l'adreça amb què entres a Recipok no hi arriben.
  • El token va a la capçalera d'autenticació que indica la pantalla, a cada petició.
  • Unitats imperials, opcionals. Si la integració treballa en lliures, unces o graus Fahrenheit, ho pot demanar amb la capçalera X-Unit-System: imperial_uk, us_customary, account (les unitats configurades al teu compte) o metric. Sense aquesta capçalera tot continua en sistema mètric, com sempre.
Consell

Abans de connectar un programa nou al teu compte real, demana al teu informàtic que faci proves amb poques dades i revisa a Recipok el que ha creat. Els dubtes sobre l'API es resolen pel xat d'assistència.

Preguntes freqüents

He perdut el token, el puc tornar a veure?
No. Per seguretat, el token només es mostra una vegada, quan el crees. Si no el vas copiar, esborra’l i genera’n un de nou; després canvia la clau al programa que el feia servir.
Què passa si revoco un token?
Qualsevol programa que cridi l’API amb aquest token deixa de funcionar a l’instant. És el que has de fer si deixes de treballar amb un proveïdor o sospites que la clau ha circulat.
Per què no veig la pestanya API Token?
Els tokens d’API formen part del pla Integral, i la pantalla només la veuen l’encarregat i l’administrador. Amb un altre pla, Opcions de desenvolupador t’ensenya com és l’API, però no crea tokens.
L’API em retorna lliures i unces?
Només si la teva integració ho demana expressament. Si no ho indica, l’API respon sempre en grams, quilos, litres i graus Celsius, de manera que les connexions que ja funcionen no canvien.