Saltar al contenido principal

🔌 API de Equinos

Bienvenido a la documentación técnica del API REST de Equinos. Esta documentación te ayudará a integrar tu aplicación con nuestra plataforma.

Introducción​

El API de Equinos es una API RESTful que permite integrar aplicaciones externas con nuestra plataforma. Actualmente, el API incluye endpoints para gestionar el módulo de Escuelas de Chalanería.

ℹ️Base URL

La base URL del API es: https://api.equinos.co/api

Características​

  • ✅ RESTful: Sigue los principios REST
  • ✅ Autenticación: Firebase JWT Tokens
  • ✅ JSON: Todas las respuestas en formato JSON
  • ✅ Versionado: Endpoints versionados por módulo
  • ✅ Permisos: Control de acceso basado en roles y permisos

Módulos Disponibles​

🎓 Escuelas de Chalanería​

API completo para gestionar escuelas de equitación:

  • Gestión de estudiantes, instructores y clases
  • Control de asistencia y pagos
  • Administración de caballos y horarios
  • Reportes y estadísticas

👉 Ver documentación del módulo Escuelas

🐴 Criaderos​

Documentación próximamente

🏠 Pesebreras​

Documentación próximamente

Autenticación​

Todas las peticiones al API requieren autenticación mediante Firebase JWT Tokens.

⚠️Importante

Asegúrate de incluir el token en el header Authorization de todas las peticiones.

👉 Ver guía de autenticación

Respuestas del API​

Formato de Respuesta Exitoso​

{
  "data": {
    // Datos del recurso
  },
  "meta": {
    // Metadatos (paginación, etc.)
  }
}

Formato de Error​

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Mensaje de error descriptivo",
    "details": {
      // Detalles adicionales del error
    }
  }
}

Códigos de Estado HTTP​

CódigoDescripción
200OK - Petición exitosa
201Created - Recurso creado exitosamente
400Bad Request - Datos inválidos
401Unauthorized - Token inválido o expirado
403Forbidden - Sin permisos para esta acción
404Not Found - Recurso no encontrado
409Conflict - Conflicto (ej: horario duplicado)
422Unprocessable Entity - Validación fallida
500Internal Server Error

Rate Limiting​

ℹ️

El API tiene límites de tasa para prevenir abusos. Los límites actuales son:

  • 1000 peticiones por hora por usuario autenticado
  • Los headers X-RateLimit-Limit y X-RateLimit-Remaining indican el estado actual

Próximos Pasos​

  1. Autenticación - Aprende a autenticarte en el API
  2. Módulo Escuelas - Documentación completa del módulo de Escuelas
  3. Ejemplos de código - Ejemplos en diferentes lenguajes

Soporte​

¿Necesitas ayuda con el API?

  • 📧 Email: api@equinos.co
  • 📚 Documentación: Esta guía
  • 🐛 Reportar problemas: GitHub Issues

Última actualización: Enero 2026