Zum Hauptinhalt springen
Header

​
Überblick

Die Twenty API ermöglicht Entwicklern die programmgesteuerte Interaktion mit der Twenty CRM-Plattform. Mit der API können Sie Twenty mit anderen Systemen integrieren, die Datensynchronisation automatisieren und benutzerdefinierte Lösungen rund um Ihre Kundendaten entwickeln. Die API bietet Endpunkte zum Erstellen, Lesen, Aktualisieren und Löschen von zentralen CRM-Objekten (wie Personen und Unternehmen) sowie zum Zugriff auf Metadatenkonfigurationen. API-Spielplatz: Sie können jetzt auf den API-Spielplatz in den Einstellungen der App zugreifen. To try out API calls in real-time, log in to your Twenty workspace and navigate to Settings → APIs & Webhooks. Dies öffnet den integrierten API-Spielplatz und die Einstellungen für API-Schlüssel. Zu den API-Einstellungen gehen

​
Authentifizierung

Die API von Twenty verwendet API-Schlüssel zur Authentifizierung. Jede Anfrage an geschützte Endpunkte muss einen API-Schlüssel im Header enthalten.
  • API Keys: You can generate a new API key from your Twenty app’s API settings page. Jeder API-Schlüssel ist ein geheimes Token, das Zugriff auf Ihre CRM-Daten gewährt, daher sollten Sie es sicher aufbewahren. Wenn ein Schlüssel kompromittiert ist, widerrufen Sie ihn in den Einstellungen und generieren Sie einen neuen.
  • Auth-Header: Sobald Sie einen API-Schlüssel haben, fügen Sie ihn im Authorization-Header Ihrer HTTP-Anfragen ein. Verwenden Sie das Bearer-Token-System. Zum Beispiel: 
    Authorization: Bearer YOUR_API_KEY
    Ersetzen Sie YOUR_API_KEY durch den von Ihnen erhaltenen Schlüssel. Dieser Header muss bei allen API-Anfragen vorhanden sein. Wenn das Token fehlt oder ungültig ist, antwortet die API mit einem Authentifizierungsfehler (HTTP 401 Unauthorized).

​
API-Endpunkte

Auf alle Ressourcen kann sowohl über REST als auch über GraphQL zugegriffen werden.
  • Cloud: https://api.twenty.com/ oder Ihre benutzerdefinierte Domain/Subdomain
  • 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/).
Endpunkte werden in zwei Kategorien unterteilt: Core API und Metadata API. Die Core API befasst sich mit primären CRM-Daten (z.B. Personen, Unternehmen, Notizen, Aufgaben), während die Metadata API Konfigurationsdaten behandelt (wie benutzerdefinierte Felder oder Objektdefinitionen). Die meisten Integrationen verwenden hauptsächlich die Core API.

​
Core API

Zugriff auf /rest/ oder /graphql/. Die Core API dient als einheitliche Schnittstelle zur Verwaltung zentraler CRM-Entitäten (wie Personen, Unternehmen, Notizen, Aufgaben) und ihrer Beziehungen und bietet sowohl REST- als auch GraphQL-Interaktionsmodelle.

​
Metadata API

Zugriff auf /rest/metadata/ oder /metadata/. Die Endpunkte der Metadata API ermöglichen Ihnen, Informationen über Ihr Schema und Ihre Einstellungen abzurufen. Zum Beispiel können Sie Definitionen von benutzerdefinierten Feldern, Objektschemata usw. abrufen.
  • Beispiel-Endpunkte:
    • GET /rest/metadata/objects – Liste aller Objekttypen und ihrer Metadaten (Felder, Beziehungen).
    • GET /rest/metadata/objects/{objectName} – Abrufen von Metadaten für ein spezifisches Objekt (z.B. people, companies).
    • GET /rest/metadata/picklists – Abrufen von Dropdown-Feldoptionen, die im CRM definiert sind.
Die Metadaten-Endpunkte werden in der Regel genutzt, um die Struktur der Daten zu verstehen (für dynamische Integrationen oder Formularerstellung), anstatt tatsächliche Datensätze zu verwalten. Sie sind in den meisten Fällen nur lesbar. Auch hierfür ist eine Authentifizierung erforderlich (verwenden Sie Ihren API-Schlüssel).