Skip to main content

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

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.

OAuth/JWT

Autenticación segura basada en tokens JWT.

Paginación

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

Convenciones

Métodos HTTP

Códigos de respuesta

Formato de error

Paginación

Las listas usan paginación basada en cursor:
Parámetros de paginación: ?page=1&per_page=20

Límites de uso (Rate Limiting)

Los headers de respuesta incluyen información sobre tu uso:
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:
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.