Guía rápida para integrar AvenioCloud APIs
Bienvenido al portal público de APIs de AvenioCloud. Aquí encontrarás contratos OpenAPI, quickstarts y ejemplos para validar integraciones en sandbox antes de pasar a un modelo productivo de consumo medido.
Sandbox activo
Base URL: https://api.sandbox.aveniocloud.com. Solicita credenciales a integraciones@aveniocloud.com para probar con límites controlados.
Modelo comercial
Las APIs están preparadas para monetización por uso. Antes de producción, valida condiciones, cuotas y alcances con ventas@aveniocloud.com.
Detalle de servicios
| Dominio | Estado | Qué resuelve |
|---|---|---|
| Auth API | Disponible | Tokens OAuth2 client_credentials con scopes por dominio. |
| Boletas de honorarios | Disponible | Emisión, anulación, PDF, operaciones asíncronas y reintentos. |
| Observabilidad | Disponible | traceId, X-Correlation-Id e idempotencia para soporte técnico. |
| Emisión de DTEs | Roadmap | Facturas, notas y documentos tributarios electrónicos con consumo medido. |
Requisitos rápidos
Checklist mínimo para comenzar a probar en sandbox:
client_idyclient_secretemitidos por AvenioCloud.- URL base sandbox:
https://api.sandbox.aveniocloud.com. - Scopes mínimos para el dominio que integrarás, por ejemplo
boletas.readoboletas.emit. - Identificador de compañía cuando aplique:
X-Avenio-Company-Id.
| Header o parámetro | Uso |
|---|---|
Authorization: Bearer <token> | Token OAuth2 para consumir APIs protegidas. |
X-Avenio-Authorization: <token> | Header alternativo usado por algunos flujos existentes. |
Idempotency-Key | UUID por operación para evitar duplicados en reintentos. |
X-Correlation-Id | Trazabilidad end-to-end entre tus logs y soporte AvenioCloud. |
scope | Alcances solicitados al invocar Auth API. |
Seguridad y buenas prácticas
- Usa scopes mínimos por dominio y rota credenciales ante cualquier sospecha.
- Evita compartir
client_secreten repositorios o logs. - Usa
Idempotency-Keyen endpoints transaccionales para reintentos seguros. - Registra
traceIdyX-Correlation-Iden tus sistemas de monitoreo.
Trazabilidad y soporte
Todas las respuestas incluyen un traceId. Si necesitas ayuda, comparte ese identificador junto con fecha, endpoint, ambiente y X-Correlation-Id enviado por tu sistema.
Sandbox vs producción
- Las credenciales de sandbox son de prueba; no las uses en tu ambiente productivo.
- El sandbox tiene límites por
client_id; contáctanos si necesitas ampliar cuotas. - Producción puede operar bajo planes, cuotas y cobro por operación según el dominio API.
- Antes de activar producción, valida condiciones comerciales y soporte operativo.
Contacto
| Equipo | Correo | Cuándo escribir |
|---|---|---|
| Integraciones API | integraciones@aveniocloud.com | Credenciales sandbox, aumento de límites, dudas técnicas o bugs. |
| Ventas API | ventas@aveniocloud.com | Cotización de producción, planes de consumo o APIs a medida. |