API pública de Recipok y tokens de acceso
Plan Integral
Cómo crear y revocar los tokens de la API, qué datos se pueden leer y escribir y dónde está la documentación para tu técnico de sistemas.
Para qué sirve
La API pública es la puerta para que otro programa lea y escriba en tu cuenta de Recipok sin que nadie copie datos a mano: tu tienda en línea que crea pedidos, tu programa de gestión que recoge las remisiones, una hoja de cálculo que consulta el inventario cada mañana.
Cada programa entra con un token, una clave larga que tú creas, le das a quien hace la conexión y puedes revocar cuando quieras. Este artículo es para el dueño que tiene que crear esa clave y para el técnico de sistemas que la va a usar.
Antes de empezar
- Los tokens forman parte del plan Integral.
- Los crea un usuario con rol de encargado o administrador.
- Necesitas a alguien que programe la conexión: quien te da soporte con tu programa de gestión o tu técnico de sistemas. Si no lo tienes, consulta Conecta Recipok con tu facturación, contabilidad o punto de venta: también hacemos integraciones a la medida.
Dónde está
En el menú de tu cuenta, arriba a la derecha, entra a Integraciones y abre la pestaña API Token. La pantalla Opciones de desarrollador muestra la misma información; con un plan distinto del Integral solo describe la API y avisa que tu plan no crea tokens.
1URL base de la API: https://api.recipok.com · Cabecera de autenticación · Ejemplo de petición
Ver documentación completa de la API
| Nombre | Estado | |
|---|---|---|
| Tienda en línea | Guardado de forma segura | 2Eliminar |
Nombre del token: Ej: Integración Zapier, Desarrollo local, etc.
3Generar token
- 1Los datos para tu técnico: la dirección de la API, la cabecera donde va el token y un ejemplo listo para copiar.
- 2Cada token tiene nombre: así sabes qué programa lo usa y cuál borrar.
- 3Generar token crea la clave y te la muestra una sola vez.
Crear un token
Ponle un nombre
En Crear nuevo token, escribe en Nombre del token para qué es: «Tienda en línea», «Contador», «Pruebas del técnico». Un token por programa.
Haz clic en Generar token
Aparece el aviso Copia este token ahora. Haz clic en Copiar y guárdalo en un lugar seguro o envíalo directamente a quien hará la conexión.
Confirma
Al hacer clic en Confirmar el token se oculta para siempre. En la lista queda como «Guardado de forma segura»: Recipok lo guarda cifrado y nadie puede volver a leerlo.
Revocar tokens
- Para retirar una clave, bórrala desde Tus tokens con Eliminar. El programa que la usaba deja de entrar al instante.
- El administrador ve además Tokens de otros usuarios, con su propietario, y puede usar Revocar token en cualquiera de ellos. Útil cuando alguien deja la empresa.
Un token da acceso a los datos de tu empresa. No lo pegues en correos a varias personas ni en documentos compartidos, y crea uno distinto para cada programa: así puedes cortar uno sin detener los demás.
Qué puede hacer un programa con la API
| Área | Ejemplos |
|---|---|
| Recetas | Consultar recetas con sus ingredientes, presentaciones, precios e IVA e información nutricional. |
| Ingredientes y proveedores | Leer y registrar ingredientes; consultar proveedores. |
| Compras e inventario | Registrar entradas de mercancía y consultar o ajustar el inventario. |
| Producción | Crear órdenes de producción, asignar lotes y finalizarlas. |
| Ventas | Crear pedidos de venta, marcarlos como entregados, registrar salidas con sus lotes y consultar o crear clientes. |
| HACCP | Crear y consultar registros HACCP y ubicaciones. |
Para tu técnico de sistemas
- La documentación técnica completa está en api.recipok.com/api/doc (botón Ver documentación completa de la API). Se puede leer en varios idiomas.
- La API responde en su propio dominio: las peticiones enviadas a la dirección con la que entras a Recipok no llegan a ella.
- El token va en la cabecera de autenticación que indica la pantalla, en cada petición.
- Unidades imperiales, opcionales. Si la integración trabaja en libras, onzas o grados Fahrenheit, puede pedirlo con la cabecera X-Unit-System:
imperial_uk,us_customary,account(las unidades configuradas en tu cuenta) ometric. Sin esa cabecera todo sigue en sistema métrico, como siempre.
Antes de conectar un programa nuevo a tu cuenta real, pide a tu técnico que pruebe con pocos datos y revisa en Recipok lo que creó. Las dudas sobre la API se resuelven por el chat de soporte.