Skip to main content

​
Gestión de API Keys

Una vez tengas tu clave, prueba peticiones firmadas en el navegador en el Sandbox de la API — pega la API key y el secret, y el playground firma las peticiones automáticamente.
Las API keys permiten que tus integraciones se autentiquen con SalesOS usando el esquema de peticiones firmadas P2S-SIGN-V1. Las claves se crean y gestionan exclusivamente desde el Dashboard de SalesOS.
La gestión de API keys requiere la capability admin.integrations. Los owners y admins del tenant la tienen por defecto.

​
Crear una clave

1

Abre el Dashboard

Ve a dashboard.play2sell.com (o staging) e inicia sesión con tu cuenta de administrador.
2

Navega a API Keys

Ve a Integraciones > API Keys en el menú lateral.
3

Crea una nueva clave

Haz clic en Crear API Key y completa:
  • Nombre — Un nombre descriptivo (ej.: “Sincronización CRM Nocturna”, “Formularios del Sitio”)
  • Alcance — Marque lo que la integración va a llamar. Para una pantalla de inicio de súper app: checkin:read, missions:read, campaigns:read, progress:read y earnings:read. Para la integración estándar: default:sync
  • Límite de tasa — Solicitudes por hora (por defecto: 1.000)
  • Expiración — Fecha de vencimiento opcional
4

Copia los dos valores

Tras la creación, el Dashboard muestra dos valores, una sola vez:
  • API Key — identificador público, ej. sk_live_a1b2c3d4.... Se envía en el header Authorization en cada petición firmada.
  • API Key Secret — usado para calcular la firma de la petición. Nunca viaja por la red.
Copia ambos inmediatamente y guárdalos en un lugar seguro (variables de entorno, gestor de secretos).
El API Key Secret se muestra solo una vez en el momento de la creación. Si lo pierdes, revoca la clave y crea una nueva — no hay forma de recuperar el secret.

​
Gestionar claves existentes

La misma pantalla Integraciones > API Keys te permite:
  • Ver todas las claves activas, revocadas y expiradas (el secret nunca se muestra de nuevo)
  • Revocar una clave — deja de funcionar inmediatamente, preservando el historial de auditoría
  • Eliminar una clave — la remueve permanentemente (prefiere revocar)
  • Monitorear uso — ve el conteo de solicitudes y la fecha del último uso

​
Alcances disponibles

Un alcance solo tiene efecto si algún endpoint lo exige. La columna Endpoint dice cuál — un alcance que ningún endpoint exige no habilita nada hoy.
Los alcances default:sync_collaborators, default:sync_activities, leads:read, leads:write, go:read, payments:read y payments:write aparecen en la lista de creación, pero ningún endpoint los exige hoy. Una clave creada solo con ellos se acepta al crearla y recibe 403 en cualquier llamada. Si necesita leads o pagos, hable con nosotros antes de crear la clave.
Un conjunto de alcances vacío no es acceso total — es acceso a nada. La verificación compara lo que el endpoint exige con lo que la clave tiene: una clave sin alcances los tiene todos faltantes, y recibe 403 scope_insufficient en cada endpoint que exija alguno. Marque siempre los alcances que su integración usará.
¿Está componiendo una pantalla de inicio de súper app? Marque los cinco de una vez — checkin:read, missions:read, campaigns:read, progress:read y earnings:read. El consumidor es uno solo, y una clave es más simple de revocar que cinco.Si prefiere separar, el corte que tiene sentido es dejar earnings:read en su propia clave: es el único que expone dinero.

​
Mejores prácticas

Crea claves separadas para cada integración (sincronización CRM, formularios del sitio, API de socios). Así, si una clave se compromete, solo necesitas rotar esa.
Las claves sin expiración viven para siempre. Establece una fecha de vencimiento para forzar rotación regular — 90 días es un buen valor por defecto.
Marque solo lo que la integración usará. Dejarlo vacío no da acceso total — devuelve 403 en todo.
Revisa el conteo de solicitudes y la fecha del último uso en la lista del Dashboard. Las claves no usadas en meses pueden ser candidatas a revocación.
  1. Crea una nueva clave en el Dashboard
  2. Actualiza tu integración para usar la nueva clave + secret
  3. Verifica que la nueva clave funciona
  4. Revoca la clave antigua

​
Próximos pasos

Autenticación

Conoce el esquema de firma P2S-SIGN-V1 con ejemplos de código

Integración Activities

Empieza a enviar actividades con tu nueva clave