Saltar al contenido principal
Header

​
Resumen

La API de Twenty permite a los desarrolladores interactuar programáticamente con la plataforma de CRM de Twenty. Usando la API, puedes integrar Twenty con otros sistemas, automatizar la sincronización de datos y crear soluciones personalizadas en torno a los datos de tus clientes. La API proporciona puntos de acceso para crear, leer, actualizar y eliminar objetos principales de CRM (como personas y empresas) y acceder a la configuración de metadatos. Zona de Pruebas de API: Ahora puedes acceder a la Zona de Pruebas de API dentro de la configuración de la aplicación. Para probar las llamadas de API en tiempo real, inicia sesión en tu espacio de trabajo de Twenty y navega a Configuración → APIs & Webhooks. Esto abrirá la Zona de Pruebas de API en la aplicación y la configuración para las claves de API. Ir a Configuración de API

​
Autenticación

La API de Twenty utiliza claves de API para la autenticación. Todas las solicitudes a puntos de acceso protegidos deben incluir una clave de API en el encabezado.
  • Claves de API: Puedes generar una nueva clave de API desde la página de Configuración de API en tu aplicación de Twenty. Cada clave de API es un token secreto que otorga acceso a tus datos de CRM, por lo que debes mantenerlo seguro. Si una clave está comprometida, revócala desde la configuración y genera una nueva.
  • Encabezado de Autenticación: Una vez que tengas una clave de API, inclúyela en el encabezado Authorization de tus solicitudes HTTP. Usa el esquema de token Bearer. Por ejemplo: 
    Authorization: Bearer YOUR_API_KEY
    Reemplaza YOUR_API_KEY con la clave que obtuviste. Este encabezado debe estar presente en todas las solicitudes a la API. Si el token falta o es inválido, la API responderá con un error de autenticación (HTTP 401 No autorizado).

​
Puntos de Acceso de API

Todos los recursos se pueden acceder mediante REST o GraphQL.
  • Nube: https://api.twenty.com/ o tu dominio / subdominio personalizado
  • Self-Hosted Instances: If you are running Twenty on your own server, use your own domain in place of api.twenty.com (for example, https://{your-domain}/rest/).
Los puntos de acceso se agrupan en dos categorías: API Principal y API de Metadatos. La API Principal se ocupa de los datos principales de CRM (por ejemplo, personas, empresas, notas, tareas), mientras que la API de Metadatos cubre los datos de configuración (como campos personalizados o definiciones de objetos). La mayoría de las integraciones utilizarán principalmente la API Principal.

​
API Principal

Accesible en /rest/ o /graphql/. La API Principal sirve como una interfaz unificada para gestionar las entidades principales de CRM (personas, empresas, notas, tareas) y sus relaciones, ofreciendo tanto modelos de interacción REST como GraphQL.

​
API de Metadatos

Accesible en /rest/metadata/ o /metadata/. Los puntos de acceso de la API de Metadatos te permiten recuperar información sobre tu esquema y configuraciones. Por ejemplo, puedes obtener definiciones de campos personalizados, esquemas de objetos, etc.
  • Puntos de Acceso de Ejemplo:
    • GET /rest/metadata/objects – Lista todos los tipos de objetos y su metadato (campos, relaciones).
    • GET /rest/metadata/objects/{objectName} – Obtén metadatos para un objeto específico (por ejemplo, people, companies).
    • GET /rest/metadata/picklists – Recupera las opciones de campo de lista desplegable definidas en el CRM.
Típicamente, los puntos de acceso de metadatos se utilizan para entender la estructura de los datos (para integraciones dinámicas o creación de formularios) en lugar de gestionar registros reales. En la mayoría de los casos, son solo de lectura. También se requiere autenticación para estos (usa tu clave de API).