Referencia de API
Elige la operación de API, el modelo de autorización y el llamador correctos para cada flujo de integración de DEUNA.
En esta página
La referencia de API de DEUNA cubre las operaciones de backend del comercio y de aplicaciones de cliente publicadas en la documentación anterior. Empieza por el llamador, no solo por el nombre del recurso, porque el modelo de autorización admitido cambia según la superficie. Las demás rutas del API Gateway se excluyen intencionalmente de esta referencia.
Usa la navegación de la referencia de API para explorar las operaciones publicadas por área de producto y recurso.
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 | Órdenes, compras, capturas, reembolsos, anulaciones y consultas 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 opcional, perfiles y direcciones reutilizables, y tarjetas almacenadas |
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ía el token de acceso del usuario en el encabezado Bearer. Algunas operaciones de órdenes y wallets también requieren la clave de la aplicación del comercio o el contexto de la tienda; la página de cada operación indica su autorización y los encabezados reenviados.
Authorization: Bearer USER_ACCESS_TOKEN
X-Api-Key: APPLICATION_API_KEY
X-Store-Code: STORE_CODE
Content-Type: application/jsonVer Autenticación para manejo de credenciales, duración de tokens y rotación.
Operaciones de backend comerciales#
Operaciones de aplicaciones de clientes#
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.