API-Dokumentation: Ein erster Überblick
Willkommen zur Dokumentation der Consolidate API. Diese API ermöglicht es Ihnen, programmatisch auf Ihre Daten zuzugreifen, Arbeitsabläufe zu automatisieren und Consolidate in Ihre bestehenden Systeme zu integrieren.
Für wen ist diese Dokumentation?
Diese Dokumentation richtet sich an:
- Entwickler, die benutzerdefinierte Integrationen oder Anwendungen erstellen möchten.
- Systemadministratoren, die Prozesse automatisieren oder Daten synchronisieren wollen.
- Technisch versierte Benutzer, die die Möglichkeiten der Plattform über die Benutzeroberfläche hinaus erweitern möchten.
Unsere Integrationsmöglichkeiten
Wir bieten zwei primäre Wege für die programmatische Interaktion mit Consolidate:
- GraphQL API: Nutzen Sie unsere GraphQL API, um aktiv Daten abzufragen, zu erstellen oder zu ändern. Dies ist der richtige Weg, wenn Ihre Anwendung die Kontrolle über den Datenfluss haben und gezielte Aktionen ausführen soll.
- Webhooks: Nutzen Sie Webhooks, um von Consolidate passiv und in Echtzeit über Ereignisse benachrichtigt zu werden. Dies ist ideal, um auf Änderungen zu reagieren, ohne ständig die API abfragen zu müssen (Polling).
Leitfaden für die GraphQL API
Wenn Sie Daten aktiv über die API abrufen oder bearbeiten möchten, empfehlen wir die folgenden Schritte:
1. Verstehen Sie die Grundlagen von GraphQL
Unsere Einführungsseite erklärt die Kernkonzepte und stellt Ihnen unser wichtigstes Werkzeug vor: den interaktiven GraphQL Explorer, mit dem Sie die API live im Browser testen können.
Lesen Sie unsere GraphQL Dokumentation
2. Klären Sie Ihre Authentifizierung
Der Zugriff auf die API erfordert eine Authentifizierung mittels API-Schlüssel. Unsere Dokumentation erklärt im Detail, wie Sie einen Schlüssel erstellen und verwenden.
- Lesen Sie die Dokumentation zur API Authentifizierung
3. Erkunden Sie die API
Der beste Weg, die API kennenzulernen, ist die praktische Erkundung. Nutzen Sie den interaktiven GraphQL Explorer (https://{IHRE_URL}/graphql ), um das Schema zu durchsuchen und Test-Anfragen zu senden.
Leitfaden für Webhooks
Wenn Sie auf Ereignisse in Consolidate reagieren möchten, finden Sie alle notwendigen Informationen in unserer Webhook-Dokumentation.
- Lesen Sie die Dokumentation zu Webhooks
Wir wünschen Ihnen viel Erfolg bei der Integration Ihrer Anwendungen mit der Consolidate API