Skip to main content
La API pública se autentica solo con claves de API. No hay flujo OAuth, ni usuario y contraseña, ni sesión: una clave es todo lo que necesita una solicitud.

​
Crear una clave

1

Abre Configuración → API Keys

En el panel, entra en Configuración y abre la pestaña API Keys. Necesitas el permiso de claves de API; los propietarios de la cuenta lo tienen por defecto.
2

Crea una clave con nombre

Pulsa Crear API Key y ponle un nombre que diga para qué es (sync-crm, formulario-web). Los nombres son únicos dentro de la cuenta.
3

Cópiala ahora

La clave completa — pk_ seguido de 43 caracteres — se muestra una sola vez. Guárdala en tu gestor de secretos. Después, el panel solo muestra una vista previa (pk_abcd...).

​
Envíala en cada solicitud

Pon la clave en la cabecera Authorization como token Bearer:
En el panel Try it de cualquier endpoint, pega la clave en el campo Authorization; la solicitud sale a través del proxy del sitio de documentación, así que funciona desde el navegador.

​
Cuando falla la autenticación

La autenticación se comprueba antes que nada, así que estas respuestas llevan un cuerpo {"detail"} simple en lugar del sobre con error_code descrito en Errores:

​
Alcance: a qué llega una clave

Una clave pertenece a la cuenta en la que se creó y solo puede leer y escribir los datos de esa cuenta. Si tu cuenta es una cuenta de socio con varias sub-cuentas, una clave cubre exactamente una sub-cuenta: aquella en la que estabas al crearla.
  • Los listados devuelven solo los registros de esa sub-cuenta, incluido su count.
  • Un ID que pertenece a otra sub-cuenta no existe para tu clave: obtienes un 404 o un rechazo UNKNOWN_*, nunca datos del calendario o pipeline equivocado.
Para integrar varias sub-cuentas, crea una clave dentro de cada una y envía las solicitudes de cada sub-cuenta con su propia clave.

​
Mantén las claves a salvo

Una clave da el mismo acceso que un usuario de la cuenta. Trátala como una contraseña.
  • Usa las claves solo del lado del servidor. Nunca incrustes una en una app móvil, en el código del navegador ni en un repositorio público.
  • Crea una clave por integración, con su nombre, para que revocar una no rompa otra.
  • Revoca una clave eliminándola en Configuración → API Keys; las solicitudes con ella fallan de inmediato con 401.
  • Para rotar, crea la clave nueva, cambia tu integración y luego elimina la antigua. No hay caducidad: una clave sigue válida hasta que la elimines.