Beta privada · apertura 23 de diciembre
Referencia de la API
Esta referencia se genera desde el contrato de la API (openapi.json, versión 1.0.0), así que no se desfasa. Puedes descargar el contrato en openapi.json.
https://api.opennexum.com: Producción (claves onx_live_)https://api-sandbox.opennexum.com: Sandbox con SUNAT beta (claves onx_test_)
Todas las rutas piden Authorization: Bearer …; mira Autenticación. Los eventos que enviamos a tu sistema están en Eventos de webhook.
Saldo, consumo y recargas en soles.
| Operación | Ruta |
|---|---|
| Dice quién eres | GET /v1/yo |
| Consulta tu saldo | GET /v1/cuenta/saldo |
| Lista tu consumo | GET /v1/cuenta/consumo |
| Declara una recarga por Yape o Plin | POST /v1/cuenta/recargas |
| Abre un ticket de soporte | POST /v1/soporte/tickets |
| Lista tus tickets de soporte | GET /v1/soporte/tickets |
| Consulta un ticket de soporte | GET /v1/soporte/tickets/{id} |
| Responde en un ticket de soporte | POST /v1/soporte/tickets/{id}/mensajes |
| Cierra un ticket de soporte | POST /v1/soporte/tickets/{id}/cerrar |
Claves de API por agente, con permisos, tope y alcance por RUC.
| Operación | Ruta |
|---|---|
| Lista las claves de tu cuenta | GET /v1/claves |
| Crea una clave con tope y permisos | POST /v1/claves |
| Revoca una clave | DELETE /v1/claves/{id} |
Confirmaciones
Sección titulada «Confirmaciones»Operaciones que esperan la aprobación de una persona.
| Operación | Ruta |
|---|---|
| Consulta una aprobación pendiente | GET /v1/confirmaciones/{id} |
RUC, padrones y tipo de cambio desde fuentes oficiales.
| Operación | Ruta |
|---|---|
| Consulta un RUC | GET /v1/ruc/{ruc} |
| Consulta los padrones de un RUC | GET /v1/ruc/{ruc}/padrones |
| Consulta el tipo de cambio | GET /v1/tipo-cambio |
Emisores
Sección titulada «Emisores»RUC emisores, series y credenciales.
| Operación | Ruta |
|---|---|
| Registra un RUC emisor | POST /v1/emisores |
| Lista tus RUC emisores | GET /v1/emisores |
| Consulta un RUC emisor | GET /v1/emisores/{ruc} |
| Guarda credenciales en la bóveda | PUT /v1/emisores/{ruc}/credenciales |
| Lista las series de un emisor | GET /v1/emisores/{ruc}/series |
| Crea una serie | POST /v1/emisores/{ruc}/series |
Comprobantes
Sección titulada «Comprobantes»Facturas, boletas y notas: emitir, consultar, descargar y dar de baja.
| Operación | Ruta |
|---|---|
| Ensaya un comprobante sin emitirlo | POST /v1/emisores/{ruc}/comprobantes/validar |
| Emite una factura, boleta o nota | POST /v1/emisores/{ruc}/comprobantes |
| Lista comprobantes de un emisor | GET /v1/emisores/{ruc}/comprobantes |
| Consulta un comprobante | GET /v1/emisores/{ruc}/comprobantes/{id} |
| Descarga el XML firmado | GET /v1/emisores/{ruc}/comprobantes/{id}/xml |
| Descarga el CDR | GET /v1/emisores/{ruc}/comprobantes/{id}/cdr |
| Descarga el PDF | GET /v1/emisores/{ruc}/comprobantes/{id}/pdf |
| Da de baja un comprobante | POST /v1/emisores/{ruc}/comprobantes/{id}/anular |
| Pregunta a SUNAT el estado de un comprobante | POST /v1/emisores/{ruc}/comprobantes/{id}/consultar-sunat |
Resúmenes
Sección titulada «Resúmenes»Resúmenes diarios de boletas y comunicaciones de baja.
| Operación | Ruta |
|---|---|
| Envía el resumen diario de boletas | POST /v1/emisores/{ruc}/resumenes |
| Lista resúmenes y comunicaciones de baja | GET /v1/emisores/{ruc}/resumenes |
| Consulta un resumen | GET /v1/emisores/{ruc}/resumenes/{id} |
Guías de remisión remitente.
| Operación | Ruta |
|---|---|
| Emite una guía de remisión remitente | POST /v1/emisores/{ruc}/guias |
| Lista guías de un emisor | GET /v1/emisores/{ruc}/guias |
| Consulta una guía | GET /v1/emisores/{ruc}/guias/{id} |
Propuestas de ventas (RVIE) y compras (RCE).
| Operación | Ruta |
|---|---|
| Pide la propuesta del SIRE de un periodo | POST /v1/emisores/{ruc}/sire/propuestas |
| Consulta una propuesta del SIRE | GET /v1/emisores/{ruc}/sire/propuestas/{id} |
| Lista las líneas de una propuesta del SIRE | GET /v1/emisores/{ruc}/sire/propuestas/{id}/registros |
Conexiones
Sección titulada «Conexiones»Números de WhatsApp, cuentas de Instagram y páginas de Messenger conectadas.
| Operación | Ruta |
|---|---|
| Crea una conexión de WhatsApp, Instagram o Messenger | POST /v1/conecta/conexiones |
| Lista tus conexiones | GET /v1/conecta/conexiones |
| Consulta una conexión | GET /v1/conecta/conexiones/{id} |
| Borra una conexión | DELETE /v1/conecta/conexiones/{id} |
| Prueba una conexión | POST /v1/conecta/conexiones/{id}/probar |
Mensajes
Sección titulada «Mensajes»Bandeja, envío de mensajes y de comprobantes.
| Operación | Ruta |
|---|---|
| Envía un mensaje | POST /v1/conecta/mensajes |
| Consulta un mensaje | GET /v1/conecta/mensajes/{id} |
| Lista conversaciones | GET /v1/conecta/conversaciones |
| Consulta una conversación | GET /v1/conecta/conversaciones/{id} |
| Lista los mensajes de una conversación | GET /v1/conecta/conversaciones/{id}/mensajes |
| Envía un comprobante por mensaje | POST /v1/conecta/comprobantes/enviar |
Plantillas
Sección titulada «Plantillas»Plantillas de mensaje para escribir fuera de la ventana de atención.
| Operación | Ruta |
|---|---|
| Lista plantillas | GET /v1/conecta/plantillas |
| Crea una plantilla | POST /v1/conecta/plantillas |
Webhooks
Sección titulada «Webhooks»Eventos normalizados y firmados hacia tu sistema.
| Operación | Ruta |
|---|---|
| Registra un webhook | POST /v1/conecta/webhooks |
| Lista tus webhooks | GET /v1/conecta/webhooks |
| Borra un webhook | DELETE /v1/conecta/webhooks/{id} |
| Envía un evento de prueba | POST /v1/conecta/webhooks/{id}/probar |
| Rota el secreto de un webhook | POST /v1/conecta/webhooks/{id}/rotar-secreto |
| Lista entregas de eventos | GET /v1/conecta/entregas |
| Reintenta una entrega | POST /v1/conecta/entregas/{id}/reintentar |