Referencia de API
Elija la superficie API DEUNA, el modelo de autorización y la persona que llama correctos para cada flujo de integración.
En esta página
DEUNA ofrece superficies de API públicas para backends de comercios, aplicaciones de clientes, socios y callbacks de proveedores. Empieza por identificar al consumidor, no solo el nombre del recurso, porque el modelo de autorización admitido cambia según la superficie. Las API internas de administración y gestión se excluyen intencionalmente.
Usa la catálogo completo de terminales para buscar cada operación configurada de API Gateway por consumidor previsto, servicio propietario, autorización o encabezado.
URL base#
Utilice la URL base de la zona de pruebas mientras construye. Cambie a producción solo después de recibir las credenciales de producción y completar la certificación.
Elija la superficie API#
| Superficie | persona que llama | Autorización | Úselo para |
|---|---|---|---|
| Backend comercial · servidor a servidor | Infraestructura comercial confiable | Clave API privada en X-Api-Key; X-Store-Code y encabezados de idempotencia cuando sea necesario | Pedidos, compras, capturas, devoluciones, anulaciones, consentimientos y lecturas operativas |
| Aplicación de cliente · usuario a servidor | Aplicación web o móvil para comerciantes que actúa en nombre de un cliente. | Contexto de aplicación pública más usuario Authorization: Bearer … después de iniciar sesión; nunca insertar una clave privada | Inicio de sesión, perfil, direcciones, tarjetas almacenadas y flujos de billetera autorizados por el cliente |
| Backend de red o socio | Integración de red o plataforma aprobada | Credenciales de socio y contexto de inquilino/red definidos durante la incorporación | Órdenes, configuración e informes en el ámbito de la red |
| Devolución de llamada de proveedor · proveedor a DEUNA | Proveedor de pago, fraude, billetera o plataforma | Contrato de devolución de llamada específico del proveedor; la puerta de enlace reenvía encabezados de devolución de llamada al servicio propietario y no declara un validador de credenciales compartido | Notificaciones de estado asincrónicas; Los sistemas comerciales no deben llamar a estas rutas. |
Autenticación#
backend comercial
Envíe la clave API privada en X-Api-Key, no en el encabezado del portador. Guárdelo en una infraestructura de servidor confiable.
X-Api-Key: YOUR_PRIVATE_API_KEY
X-Store-Code: STORE_CODE
X-Idempotency-Key: order_1042-attempt_1
Content-Type: application/jsonCliente autenticado
Envíe el token de acceso del usuario en el encabezado Bearer. Algunas operaciones de pedidos y billeteras también requieren la clave de la aplicación comercial o el contexto de la tienda; el catálogo de endpoints muestra la autorización y los encabezados reenviados para cada ruta.
Authorization: Bearer USER_ACCESS_TOKEN
X-Api-Key: APPLICATION_API_KEY
X-Store-Code: STORE_CODE
Content-Type: application/jsonSocios
Las credenciales del socio y el contexto de red se proporcionan durante la incorporación. No uses una clave privada de la API de checkout como credencial de socio.
Consulta Autenticación para manejo de credenciales, duración de tokens y rotación.
Operaciones de backend comerciales#
Operaciones de aplicaciones de clientes#
Devoluciones de llamadas de proveedores#
Las rutas de devolución de llamadas de los proveedores son parte del inventario completo para que los equipos puedan identificar a la propiedad y evitar llamarlos accidentalmente. No son webhooks comerciales. Para recibir eventos DEUNA en su propio backend, configure la URL del webhook del pedido y siga Ganchos web.
Respuestas y errores#
Explora la lista completa en Códigos de error.
Versionado de ruta#
Utilice cada ruta exactamente como se publicó. API Gateway frecuentemente expone rutas canónicas sin un interno /api/v1 prefijo. Un segmento de versión como /v2 Se incluye únicamente cuando forma parte del recorrido público mostrado en el catálogo. Los cambios compatibles con versiones anteriores se enumeran en la Registro de cambios.