Zum Hauptinhalt springen

GraphQL API für Perfex CRM

Eine flexible GraphQL API, die nahtlose Drittanbieter-Verbindungen innerhalb von Perfex CRM ermöglicht. Interagieren Sie sowohl mit nativen Tabellen als auch mit benutzerdefinierten Modulen.

Übersicht​

Das GraphQL API Modul stellt einen leistungsstarken und flexiblen API-Endpunkt für Ihre Perfex CRM-Installation bereit. Im Gegensatz zu traditionellen REST APIs, bei denen Sie mehrere Endpunkte für verschiedene Ressourcen benötigen, ermöglicht GraphQL, genau die benötigten Daten in einer einzigen Anfrage abzufragen. Das Modul generiert automatisch ein Schema basierend auf Ihrer Perfex CRM-Datenbank — einschließlich nativer Tabellen und aller installierten benutzerdefinierten Module.

Hauptfähigkeiten​

FähigkeitBeschreibung
QueriesDaten aus jeder CRM-Tabelle lesen — Kunden, Rechnungen, Leads, Aufgaben und mehr
MutationsEinträge über die API erstellen, aktualisieren und löschen
Auto-generiertes SchemaDas Schema wird automatisch aus Ihrer Perfex CRM-Datenbankstruktur erstellt
Benutzerdefinierte ModuleMit Daten von Drittanbieter-Modulen interagieren, die auf Ihrem CRM installiert sind
Einzelner EndpunktAlle Operationen laufen über einen Endpunkt — keine Verwaltung mehrerer API-Routen nötig
info

Ihr GraphQL-Endpunkt ist unter https://yourdomain.com/graphql sofort nach der Aktivierung verfügbar. Das Schema wird automatisch aus Ihrer Perfex CRM-Installation generiert.

Anforderungen​

Stellen Sie vor der Installation des Moduls sicher, dass Sie haben:

  • Eine aktive Perfex CRM-Installation
  • PHP 7.4 oder höher auf Ihrem Server
  • Die cURL- und JSON-PHP-Erweiterungen aktiviert
  • Einen gültigen Lizenzschlüssel für das Modul

Installation & Aktivierung​

Befolgen Sie diese Schritte, um das GraphQL API Modul zu installieren und zu aktivieren:

  1. Entpacken Sie Ihren Download und suchen Sie upload.zip.
  2. Gehen Sie in Perfex CRM zu Setup → Module.
  3. Laden Sie upload.zip hoch und drücken Sie Installieren.
  4. Klicken Sie auf Aktivieren und geben Sie Ihren Lizenzschlüssel ein.
tipp

Nach der Aktivierung können Sie Ihren Endpunkt sofort testen, indem Sie https://yourdomain.com/graphql in Ihrem Browser besuchen oder eine Anfrage mit einem Tool wie Postman oder GraphQL Playground senden.

Nach der Installation​

Sobald das Modul aktiviert ist, ist der GraphQL-Endpunkt live und bereit, Anfragen zu empfangen:

  1. Endpunkt finden — Die API ist unter https://yourdomain.com/graphql verfügbar.
  2. Anfragen authentifizieren — Siehe die Authentifizierung-Anleitung für Details zum Erhalt und zur Verwendung von API-Tokens.
  3. Schema erkunden — Verwenden Sie GraphQL-Introspection, um alle verfügbaren Queries und Mutations zu entdecken.
  4. Mit Abfragen beginnen — Siehe die Datenoperationen-Anleitung für Query- und Mutation-Beispiele.
warnung

Der GraphQL-Endpunkt ist über die URL öffentlich erreichbar, aber alle Anfragen erfordern eine ordnungsgemäße Authentifizierung. Stellen Sie sicher, dass Sie Ihre API-Tokens konfigurieren und sicher aufbewahren.

Nächste Schritte​

Erkunden Sie die folgenden Anleitungen, um das Beste aus dem GraphQL API Modul herauszuholen:

  • Authentifizierung — Erfahren Sie, wie Sie API-Anfragen mit Tokens authentifizieren
  • Warum GraphQL — Verstehen Sie die Vorteile von GraphQL gegenüber traditionellen REST APIs
  • Hauptvorteile — Entdecken Sie die Vorteile der Nutzung dieses Moduls
  • Datenoperationen — Sehen Sie Beispiele für Queries und Mutations

Support​

Wenn Sie während der Installation auf Probleme stoßen oder Hilfe mit der API benötigen, besuchen Sie das Themesic Support-Portal, um ein Support-Ticket zu eröffnen.