Saltar al contenido principal

Referencia para desarrolladores de Dashboard

Crea flujos de trabajo para operadores sin acoplar una integración a detalles privados de implementación de Dashboard. Dashboard es un cliente web: compone rutas para operadores y contextos de interfaz compartidos, mientras Ordering.co API autoriza el acceso a datos y los cambios. Los proveedores externos siguen siendo responsables de sus credenciales, disponibilidad y resultados.

Elige la referencia adecuada​

ObjetivoReferencia
Autenticar un cliente, llamar una operación de Ordering.co API o inspeccionar esquemas de solicitudes y respuestasUsa la referencia de API canónica del encabezado de documentación. Empieza por el contrato público POST /auth.
Conectar configuración, plugins, sistemas POS o canales de venta, servicios de entrega, pagos, mapas, notificaciones o analíticaIntegraciones, API y transferencias a proveedores
Cambiar el código fuente de Dashboard, ejecutarlo localmente, probarlo o preparar una versiónGuía de ingeniería de Dashboard

La referencia de integración explica responsabilidades y transferencias. La guía de ingeniería explica el repositorio y el flujo de trabajo de quienes contribuyen. Ninguna sustituye la referencia de API ni la documentación aprobada de un proveedor.

Límite de arquitectura​

Dashboard combina:

  • una aplicación Vite y React que se encarga del enrutamiento y la composición de páginas;
  • una capa de componentes dentro del repositorio que proporciona contextos de API, sesión, configuración, pedidos, negocios, idioma, tiempo real e interfaz;
  • configuración de compilación y ejecución que selecciona un proyecto y el límite del backend; y
  • el navegador y proveedores externos para capacidades como mapas, pagos, analítica, soporte, notificaciones y entrega en tiempo real.

Que una ruta del cliente sea visible no equivale a autorización. Un valor de configuración, registro de plugin, indicador de función o control renderizado muestra que el cliente puede intentar un flujo; la API y el proveedor aún deciden si el actor y el recurso actuales cumplen los requisitos.

La disponibilidad de proveedores y las capacidades compatibles dependen de la configuración del proyecto y de las versiones de Dashboard y API desplegadas. Confirma la configuración del proyecto antes de depender de una integración.

Guía de producto​

Para conocer el comportamiento dirigido a operadores, empieza por la documentación del producto Dashboard. Usa las referencias para desarrolladores cuando necesites identificar al responsable técnico de una transferencia, un valor de configuración, un fallo o un cambio de código.