Saltar al contenido principal

​
API de SalesOS

La API REST de SalesOS te permite integrar la plataforma con tus sistemas existentes, automatizar procesos y construir aplicaciones personalizadas sobre los datos de ventas.

​
URL base

https://api.play2sell.com/v1

​
Características principales

REST

API RESTful con endpoints intuitivos que siguen las convenciones estándar HTTP.

JSON

Todas las solicitudes y respuestas usan formato JSON.

Auth0/JWT

Autenticación segura basada en tokens JWT emitidos por Auth0.

Paginación

Respuestas paginadas para manejar grandes volúmenes de datos de forma eficiente.

​
Convenciones

​
Métodos HTTP

MétodoUso
GETConsultar recursos
POSTCrear nuevos recursos
PUTActualizar un recurso completo
PATCHActualizar campos específicos de un recurso
DELETEEliminar un recurso

​
Códigos de respuesta

CódigoSignificado
200Solicitud exitosa
201Recurso creado exitosamente
400Solicitud inválida (datos incorrectos)
401No autenticado (token inválido o expirado)
403No autorizado (permisos insuficientes)
404Recurso no encontrado
429Límite de solicitudes alcanzado (rate limit)
500Error interno del servidor

​
Formato de error

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "El campo 'email' es requerido",
    "details": [
      {
        "field": "email",
        "message": "Este campo no puede estar vacío"
      }
    ]
  }
}

​
Paginación

Las listas usan paginación basada en cursor: 
{
  "data": [...],
  "pagination": {
    "total": 150,
    "page": 1,
    "per_page": 20,
    "total_pages": 8
  }
}
Parámetros de paginación: ?page=1&per_page=20

​
Límites de uso (Rate Limiting)

PlanLímite
Starter100 solicitudes/minuto
Business500 solicitudes/minuto
Enterprise2,000 solicitudes/minuto
Los headers de respuesta incluyen información sobre tu uso: 
X-RateLimit-Limit: 500
X-RateLimit-Remaining: 487
X-RateLimit-Reset: 1709251200
Si alcanzas el límite de solicitudes, recibirás un error 429. Espera hasta que el contador se reinicie o considera optimizar tus llamadas.

​
Primeros pasos

1

Obtén tus credenciales

Consulta la guía de autenticación para obtener tus tokens de acceso.
2

Haz tu primera llamada

Prueba con una solicitud simple como listar tus leads:
curl -H "Authorization: Bearer TU_TOKEN" \
  https://api.play2sell.com/v1/leads
3

Explora los endpoints

Revisa la documentación de cada endpoint para conocer todos los recursos disponibles.

​
Endpoints disponibles

Leads

CRUD de leads, búsqueda y filtrado.

Ventas

Oportunidades, pipeline y actividades.

Usuarios

Gestión de usuarios y equipos.

Webhooks

Recibe notificaciones de eventos en tiempo real.

​
Próximos pasos

Autenticación

Configura la autenticación para la API.

Integraciones

Conecta SalesOS con tus herramientas.