Primeros pasos con la API de Gestiono

Esta guía te ayudará a comenzar con la API de Gestiono de manera rápida y eficiente.

Requisitos previos

Antes de comenzar, asegúrate de tener:

• Una cuenta de Gestiono con acceso a la API habilitado
• Conocimientos básicos de APIs REST y métodos HTTP
• Tu lenguaje de programación y cliente HTTP preferidos

Lista de inicio rápido

1. ✅ Obtener credenciales — Tu API key e ID de organización
2. ✅ Configurar autenticación — Encabezados correctos en cada solicitud
3. ✅ Realizar tu primera solicitud — Probar conectividad con una llamada simple
4. ✅ Explorar conceptos clave — Entidades principales de la plataforma
5. ✅ Construir tu integración — Implementar tu caso de uso

Credenciales de la API

Para acceder a la API de Gestiono, necesitarás:

API Key

Tu API key identifica tu aplicación y da acceso a los datos de tu organización.

# Formato del API key
API_KEY="gst_live_1234567890abcdef..."

ID de organización

Cada cuenta de Gestiono pertenece a una organización. Necesitarás tu ID de organización para la mayoría de llamadas.

# Formato del ID de organización
ORGANIZATION_ID="org_1234567890"

URL base y endpoints

Todos los endpoints siguen este patrón:

https://api.gestiono.app/v1/{resource}

Versiones disponibles

• v1: Versión estable actual (recomendada)
• v2: Próxima generación (solo algunos recursos)

Métodos HTTP

La API utiliza métodos HTTP estándar:

• GET — Obtener datos
• POST — Crear recursos
• PUT — Actualizar recursos
• DELETE — Eliminar recursos
• PATCH — Actualizaciones parciales

Formato de respuesta

Todas las respuestas se devuelven en formato JSON:

{
"success": true,
"data": {
  // Response data here
},
"message": "Operación realizada con éxito",
"timestamp": "2024-10-14T10:30:00Z"
}

Formato de error

Cuando ocurre un error, la API devuelve:

{
"success": false,
"error": {
  "code": "VALIDATION_ERROR",
  "message": "Entrada inválida",
  "details": {
    "field": "email",
    "issue": "Formato de email inválido"
  }
},
"timestamp": "2024-10-14T10:30:00Z"
}

Límites de uso (Rate limiting)

La API implementa límites de uso para garantizar un uso justo:

• Plan Estándar: 1,000 solicitudes por hora
• Plan Profesional: 5,000 solicitudes por hora
• Plan Empresarial: 25,000 solicitudes por hora

Los siguientes encabezados se incluyen en todas las respuestas:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1697275200

Próximos pasos

Ahora que entiendes lo básico, continúa con:

1. Autenticación — Configura tus credenciales
2. Conceptos clave — Conoce el modelo de datos
3. Ejemplos — Revisa implementaciones prácticas

¿Necesitas ayuda?

• Revisa los Ejemplos para ver código
• Consulta la Referencia de API para detalles
• Contacta soporte si encuentras problemas