Saltar al contenido principal
Version: v2.0 (RESTful)

Arquitectura de Integración

Esta sección define el protocolo técnico para plataformas (e-commerce, marketplaces, ERPs) que requieren aprovisionar y gestionar cuentas de cobro QR.

important

El proceso de Onboarding de Vendis no es 100% por API, sino que es un flujo mixto e híbrido que combina:

  1. API (Backend-to-Backend): Para que la plataforma solicite de manera asíncrona la intención de registro del comercio y posteriormente genere su API Key.
  2. Pantallas Web (Interactiva): El comercio es redirigido a una interfaz web segura de Vendis para completar sus datos, realizar el pago de activación y finalmente aceptar los términos del contrato de servicios.
  3. WhatsApp (Notificaciones): Vendis envía de forma automatizada las credenciales temporales y alertas clave directamente al número de WhatsApp del comercio.

Actores​

El ecosistema de Onboarding distingue tres roles principales:

  1. Plataforma Integradora (Master): Sistema que automatiza el alta de sus clientes. Utiliza una Master API Key.
  2. Cuenta Comercio (Business Code): Entidad final que procesará los cobros a través de los QRs.
  3. Vendis API: Proveedor de la infraestructura de cobros y conciliación.

Requisitos Previos​

Para consumir los servicios de Onboarding, la Plataforma Integradora debe:

  1. Master API Key: Obtener la clave maestra contactando a Soporte Técnico. Esta clave debe enviarse en el header X-API-KEY.
  2. Endpoint de Webhook: Exponer y registrar un endpoint público (HTTPS) capaz de recibir notificaciones asíncronas (POST) para eventos de registro de cuentas.

Workflow​

El ciclo de vida para dar de alta a un nuevo comercio consta de 5 fases:

  1. Generación de Intent: La plataforma solicita un token de registro temporal.
  2. Activación: El comercio completa los datos (incluyendo su número de WhatsApp) y realiza el pago de activación mediante un QR.
  3. Sincronización: Vendis notifica vía Webhook a la plataforma sobre el éxito de la activación, proveyendo el business_code.
  4. Generación de Credenciales: La plataforma utiliza el business_code para generar una API Key exclusiva para ese comercio e inyectarla en su base de datos.
  5. Aceptación de Contrato: Vendis envía credenciales de acceso al comercio vía WhatsApp. El comercio debe ingresar al panel web y aceptar los términos y condiciones para habilitar la generación de QRs.