Saltar al contenido principal

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

DominioEstadoQué resuelve
Auth APIDisponibleTokens OAuth2 client_credentials con scopes por dominio.
Boletas de honorariosDisponibleEmisión, anulación, PDF, operaciones asíncronas y reintentos.
ObservabilidadDisponibletraceId, X-Correlation-Id e idempotencia para soporte técnico.
Emisión de DTEsRoadmapFacturas, notas y documentos tributarios electrónicos con consumo medido.

Requisitos rápidos

Checklist mínimo para comenzar a probar en sandbox:

  • client_id y client_secret emitidos por AvenioCloud.
  • URL base sandbox: https://api.sandbox.aveniocloud.com.
  • Scopes mínimos para el dominio que integrarás, por ejemplo boletas.read o boletas.emit.
  • Identificador de compañía cuando aplique: X-Avenio-Company-Id.
Header o parámetroUso
Authorization: Bearer <token>Token OAuth2 para consumir APIs protegidas.
X-Avenio-Authorization: <token>Header alternativo usado por algunos flujos existentes.
Idempotency-KeyUUID por operación para evitar duplicados en reintentos.
X-Correlation-IdTrazabilidad end-to-end entre tus logs y soporte AvenioCloud.
scopeAlcances 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_secret en repositorios o logs.
  • Usa Idempotency-Key en endpoints transaccionales para reintentos seguros.
  • Registra traceId y X-Correlation-Id en 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

EquipoCorreoCuándo escribir
Integraciones APIintegraciones@aveniocloud.comCredenciales sandbox, aumento de límites, dudas técnicas o bugs.
Ventas APIventas@aveniocloud.comCotización de producción, planes de consumo o APIs a medida.