Nyclas API
Nyclas bietet APIs in REST und GraphQL. – Nutzen Sie die Metadata API für alles, was Ihren Arbeitsbereich und dessen Datenmodell betrifft. – Nutzen Sie die Core API für alles, was Ihre Datensätze betrifft.
Ihre individuellen APIs
Für Ihren Arbeitsbereich werden individuelle APIs generiert, die Ihr individuelles Datenmodell perfekt abbilden. Das bedeutet, dass Sie für jedes Ihrer benutzerdefinierten Objekte und Felder einen dedizierten Endpunkt haben – das macht die Entwicklung deutlich angenehmer!
Vorteile der GraphQL-APIs
– Batch-Operationen sind mit den GraphQL-APIs verfügbar. Sie müssen lediglich den Pluralnamen Ihres Objekts verwenden. Beispiel: Verwenden Sie für die Batch-Erstellung die Mutation „CreateCompanies“ anstelle von „CreateCompany“. (Aus diesem Grund müssen Singular- und Pluralnamen Ihres Objekts unterschiedlich sein.)
Die Option Upsert ist mit den GraphQL-APIs verfügbar.
API-Dokumentation
Die Nyclas-API-Dokumentation finden Sie in Ihren Arbeitsbereichseinstellungen unter „APIs & Webhooks“.
Da einzigartige APIs generiert werden, die Ihr Datenmodell perfekt abbilden, erstellt Nyclas eine individuelle API-Dokumentation.
Deshalb benötigen Sie für den Zugriff einen API-Schlüssel.
Sie finden dort auch einen Playground, auf dem Sie die APIs und die zurückgegebenen Daten testen können.
API-Schlüssel
API-Schlüssel ermöglichen den automatisierten Zugriff auf Ihre CRM-Daten, die Synchronisierung von Daten mit anderen Systemen und die Erstellung benutzerdefinierter Integrationen oder Lösungen.
Sie können sie beispielsweise verwenden, um Details zu einer bestimmten Person oder einem bestimmten Unternehmen abzurufen, wie z. B. Name oder Adresse.
API-Schlüssel generieren
Gehen Sie in der linken Seitenleiste zu Einstellungen.
Öffnen Sie APIs & Webhooks.
Um einen neuen Schlüssel zu generieren, klicken Sie oben rechts auf „+ Schlüssel erstellen“.
Geben Sie Ihrem API-Schlüssel einen Namen, ein Ablaufdatum und ein Logo.
Klicken Sie auf „Speichern“, um Ihren API-Schlüssel anzuzeigen.
Da der Schlüssel nur einmal sichtbar ist, bewahren Sie ihn an einem sicheren Ort auf.
Da Ihr API-Schlüssel Zugriff auf vertrauliche Informationen gewährt, sollten Sie ihn nicht an Dienste weitergeben, denen Sie nicht voll und ganz vertrauen. Sollte er an die Öffentlichkeit gelangen, kann er missbraucht werden. Sollte die Sicherheit Ihres API-Schlüssels gefährdet sein, deaktivieren Sie ihn sofort und generieren Sie einen neuen.
API-Schlüssel neu generieren
Um einen API-Schlüssel neu zu generieren, klicken Sie auf den gewünschten Schlüssel. Daraufhin wird eine Schaltfläche zur Neugenerierung des API-Schlüssels angezeigt.
Webhooks
Webhooks ermöglichen sofortige Aktualisierungen Ihrer angegebenen URL über Änderungen oder Ereignisse in Bezug auf Ihre Kundendaten.
Ein Webhook kann Ihr System beispielsweise in Echtzeit benachrichtigen, wenn jemand einen neuen Personendatensatz erstellt oder eine bestehende Notiz aktualisiert.
Webhooks erstellen
Klicken Sie unter Einstellungen → APIs & Webhooks → Webhooks auf „+“ und wählen Sie „Webhook erstellen“.
Geben Sie Ihre URL ein.
Klicken Sie auf „Speichern“.
Webhooks löschen
Suchen Sie unter Einstellungen → APIs & Webhooks → Webhooks Ihren Webhook.
Klicken Sie auf Ihren Webhook und drücken Sie Entf, um ihn zu entfernen. Ein Bestätigungs-Popup wird angezeigt.