Bienvenid@ a las APIs de AvenioCloud

Bienvenid@ a la documentación de APIs de AvenioCloud. Aquí encontrarás guías claras, referencias actualizadas y ejemplos listos para probar en nuestro sandbox (https://api.sandbox.aveniocloud.com).

Para uso en producción, el acceso a las APIs puede tener costos asociados; te recomendamos revisar condiciones y alcances con el equipo comercial de AvenioCloud escribiendo a ventas@aveniocloud.com antes de avanzar.

Detalle de servicios

Resumen de los dominios disponibles hoy y lo que cubren en el sandbox.

• Auth: obtención de tokens OAuth2 client_credentials con scopes segmentados por dominio.
• Boletas de honorarios: emisión, anulación, descarga de PDF y consulta de operaciones.
• Observabilidad: correlación con X-Correlation-Id y trazabilidad en respuestas.
• Pronto... Nuevas APIs: incorporaremos más dominios muy pronto para ampliar los casos de uso.

Requisitos rápidos

Checklist mínimo para comenzar a probar en nuestro ambiente sandbox.

• client_id y client_secret emitidos por AvenioCloud. Cada interesado debe contactarnos a integraciones@aveniocloud.com; entregamos credenciales de sandbox con límites mensuales.
• URL base sandbox: https://api.sandbox.aveniocloud.com
• Headers utilizados según contexto:
  • Idempotency-Key: UUID por operación. Esto lo administra el consumidor de cada API, permite evitar operaciones duplicadas.
  • X-Avenio-Company-Id: GUID de la empresa o persona que consumirá las APIs. Este id es provisto por AvenioCloud. Se le solicitará crear una cuenta gratis en AvenioCloud para obtener su Id.
  • X-Avenio-Authorization: <token>: Token obtenido al invocar la API de Auth.
  • Scope: Son los alcances/permisos que tendrá el token, se utilizan solo al invocar la API de Auth para darle accesos al token a APIs especificas. Los scopes requeridos se detallan en cada API o pueden ser solicitados al equipo de AvenioCloud.

Seguridad y buenas prácticas

Recomendaciones para operar de forma segura y evitar incidentes.

• Usa scopes mínimos por dominio y rota credenciales ante cualquier sospecha.
• Evita compartir client_secret en repositorios o logs.
• Aprovecha idempotencia para reintentos seguros.

Trazabilidad y soporte

Cómo facilitar el diagnóstico cuando necesites ayuda.

• Las respuestas incluyen traceId; compártelo con el equipo técnico.
• Recomendamos registrar X-Correlation-Id en tus logs para seguimiento end-to-end.

Sandbox vs producción

Diferencias clave y consideraciones antes de pasar a 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 aumentar cuotas.

Contactanos

Si tienes alguna duda o requerimiento, te recomendamos enviar un correo a los equipos:

• Equipo técnico APIs (integraciones@aveniocloud.com):
  • Ayuda con el consumo de APIs
  • Aumentar limites en Sandbox
  • Reportar algun bug o issue.
• Equipo comercial (ventas@aveniocloud.com):
  • Solicitar cotización uso de APIs en Producción
  • Evaluar desarrollo de APIs a medida