Métodos y parámetros
El Gestor de Folios 3.0 expone una API REST dividida en dos servicios:
- API de Administración — alta y configuración de facturadores y rangos primarios. La consumen los equipos de implementación y los portales de configuración.
- API de Emisión — obtención de numeración en runtime. La consumen los sistemas emisores (xPOS, API SDTA, kioscos) en cada operación.
URLs base
API de Administración (métodos Biller y Primary Range):
SBX
https://inbox-emission-numbermanager-all-adminapi-sbx.azurewebsites.netPRD
https://inbox-emission-numbermanager-all-adminapi.azurewebsites.netAPI de Emisión (métodos de numeración en runtime):
SBX
https://inbox-emission-numbermanager-all-api-sbx.azurewebsites.netPRD
https://inbox-emission-numbermanager-all-api-prd.azurewebsites.netLas páginas de cada método usan rutas relativas a estas URLs base (p. ej. POST /AddBiller).
Modelo de operación
El modelo depende del perfil del facturador:
| Facturador local | Facturador centralizado | |
|---|---|---|
| Cómo obtiene numeración | Solicita un subrango completo y lo administra localmente | Solicita un número por cada documento emitido |
| Ventajas | Menor latencia, operación offline posible, menor consumo de API | Control centralizado absoluto, sin manejo local de rangos |
| Responsabilidad del emisor | Controlar la secuencia interna y liberar subrangos no utilizados | Solicitar número antes de cada emisión |
Grupos de métodos
| Grupo | Servicio | Qué cubre |
|---|---|---|
| Biller | Administración | Alta, consulta, configuración de recarga/umbrales y baja de facturadores. |
| Primary Range | Administración | Registro, consulta y baja de rangos primarios de numeración. |
| API de Emisión | Emisión | GetNextNumber (centralizado); RefillSubRange, ReleaseSubRange y ConfirmReleaseSubRange (local). |
Flujos recomendados
Facturador local
- Crear el facturador — AddBiller.
- Configurar tamaño de subrango y umbral de recarga — SaveBillerConfiguration, SaveBillerThreshold.
- Solicitar subrango — RefillSubRange.
- Emitir documentos usando la numeración local.
- Cuando corresponda devolver numeración: consultar subrangos liberables — ReleaseSubRange — y confirmar la liberación — ConfirmReleaseSubRange.
Facturador centralizado
- Crear el facturador — AddBiller.
- Antes de cada emisión, solicitar número — GetNextNumber.
- Emitir el documento.
Buenas prácticas de integración
- No reutilizar números bajo ninguna circunstancia: cada número entregado queda reservado.
- Implementar manejo de errores y reintentos controlados.
- Registrar logs de cada solicitud al GF.
- Validar el estado del facturador antes de operar.
- Monitorear la disponibilidad de rangos primarios y los umbrales de recarga.
Consideraciones técnicas
- Todas las APIs son REST con métodos
GET/POST/DELETEy payload JSON. - Facturadores, rangos primarios y subrangos se identifican por UUID.
- Todas las operaciones quedan auditadas (campos
authorysourceen cada request).