Referencia API

Documentación completa para nuestra API REST. Construye integraciones poderosas y aplicaciones personalizadas.

Comenzando

URL Base

Todas las solicitudes de API deben realizarse a:

https://api.sales-mindo.com/v1

Autenticación

Usa tu clave API en el encabezado de Autorización:

curl -H "Authorization: Bearer TU_CLAVE_API" \
     https://api.sales-mindo.com/v1/proyectos

Límites de Velocidad

Límites de velocidad de la API por plan:

• Básico: 100 solicitudes/hora
• Profesional: 1,000 solicitudes/hora
• Empresarial: 10,000 solicitudes/hora

API de Proyectos

Listar Proyectos

Obtiene todos los proyectos de tu cuenta.

GET /proyectos

Respuesta:

{
  "data": [
    {
      "id": "proj_123",
      "nombre": "Mi Proyecto",
      "descripcion": "Descripción del proyecto",
      "estado": "activo",
      "creado_en": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "pagina": 1,
    "por_pagina": 20
  }
}

Crear Proyecto

Crea un nuevo proyecto.

POST /proyectos

Cuerpo de la Solicitud:

{
  "nombre": "Nuevo Proyecto",
  "descripcion": "Descripción del proyecto",
  "configuracion": {
    "publico": false,
    "notificaciones": true
  }
}

Obtener Proyecto

Recupera un proyecto específico por ID.

GET /proyectos/{id}

Actualizar Proyecto

Actualiza un proyecto existente.

PUT /proyectos/{id}

Eliminar Proyecto

Elimina un proyecto permanentemente.

DELETE /proyectos/{id}

API de Tareas

Listar Tareas

Obtiene tareas para un proyecto.

GET /proyectos/{id_proyecto}/tareas

Parámetros de Consulta:

• estado - Filtrar por estado (abierto, completado, archivado)
• asignado - Filtrar por ID del asignado
• limite - Número de resultados (máx 100)
• offset - Offset de paginación

Ejemplo:

curl "https://api.sales-mindo.com/v1/proyectos/proj_123/tareas?estado=abierto&limite=10" \
  -H "Authorization: Bearer TU_CLAVE_API"

Crear Tarea

Agrega una nueva tarea a un proyecto.

POST /proyectos/{id_proyecto}/tareas

Cuerpo de la Solicitud:

{
  "titulo": "Título de la tarea",
  "descripcion": "Descripción de la tarea",
  "id_asignado": "user_456",
  "fecha_vencimiento": "2024-12-31",
  "prioridad": "alta",
  "etiquetas": ["bug", "urgente"]
}

API de Usuarios

Obtener Usuario Actual

Obtiene información sobre el usuario autenticado.

GET /usuario

Listar Miembros del Equipo

Obtiene los miembros del equipo de tu organización.

GET /equipo/miembros

Invitar Usuario

Invita a un nuevo miembro del equipo.

POST /equipo/invitaciones

Webhooks

Crear Webhook

Configura notificaciones de eventos.

POST /webhooks

Cuerpo de la Solicitud:

{
  "url": "https://tu-app.com/webhook",
  "eventos": ["proyecto.creado", "tarea.completada", "usuario.invitado"],
  "activo": true
}

Listar Webhooks

Obtiene todos los webhooks configurados.

GET /webhooks

Actualizar Webhook

Modifica un webhook existente.

PUT /webhooks/{id}

Eliminar Webhook

Elimina un webhook.

DELETE /webhooks/{id}

Códigos de Estado

Formatos de Error

{
  "error": {
    "codigo": "RESOURCE_NOT_FOUND",
    "mensaje": "El proyecto especificado no fue encontrado",
    "detalles": {
      "recurso": "proyecto",
      "id": "proj_123"
    }
  }
}

Paginación

Las respuestas que devuelven múltiples elementos son paginadas:

{
  "data": [...],
  "meta": {
    "total": 100,
    "pagina": 1,
    "por_pagina": 20,
    "total_paginas": 5
  },
  "enlaces": {
    "primera": "/proyectos?pagina=1",
    "anterior": null,
    "siguiente": "/proyectos?pagina=2",
    "ultima": "/proyectos?pagina=5"
  }
}

Versionado

La API usa versionado de URL. La versión actual es v1. Notificaremos con anticipación sobre nuevas versiones.

SDKs Oficiales

• JavaScript/Node.js: npm install sales-mindo-sdk
• Python: pip install sales-mindo-sdk
• PHP: Disponible vía Composer
• Go: Disponible vía Go modules

Soporte

Para ayuda con la API:

• Documentación: docs.sales-mindo.com
• Email: api-support@sales-mindo.com
• Comunidad: community.sales-mindo.com

---

¿Necesitas ayuda para comenzar? Consulta nuestra Guía de Inicio.