Menú: Documentación

Empezar

Conceptos básicos

Qué significa cada palabra de la documentación: TPV, terminal, local, credenciales, entornos y formas de integrarse.

Estas son las palabras que verás en toda la documentación.

Las piezas

Concepto Qué es
TPV Tu software de punto de venta.
Terminal El dispositivo con el que se cobra la tarjeta. Lleva instalada la app honei Terminal.
APK Una app Android. En esta guía, tu comandera o tu TPV cuando se instala en el propio terminal y se conecta con honei dentro del mismo dispositivo.
Local Cada restaurante. En la API aparece como venue.
Sala y mesa Cómo se organiza un local. Las usa Pay at table.
Cuenta Lo que se ha consumido en una mesa y lo que ya se ha pagado. En la API aparece como tab.

Las credenciales

Concepto Para qué sirve
clientSecret Identifica tu integración. Es único por proveedor de TPV y debe guardarse solo en tu servidor.
venue-api-key Identifica el local que hace la petición. Lo puede configurar el distribuidor desde el TPV.
terminalId Identifica el terminal al que envías un cobro con la Cloud API. Lo puede configurar el distribuidor desde el TPV.

Los entornos

Concepto Para qué sirve
Staging El entorno de pruebas. Aquí desarrollas y pruebas, con un terminal que simula los cobros.
Producción El entorno real, con cobros reales. Sus credenciales son diferentes y las recibes tras la certificación.

Las formas de integrarse

Concepto Qué es
Cloud API Tu TPV llama a los servidores de honei, por internet.
Local API Tu TPV llama directamente al terminal, por la red local.
Intent Tu APK abre honei Terminal en el mismo dispositivo.
ADB La herramienta de Android con la que instalas tu APK en el terminal desde tu ordenador.