Zusammenfassung: Dieser Leitfaden richtet sich an Entwickler, IT-Architekten und Systemintegratoren, die benutzerdefinierte Anwendungen erstellen, externe Software verbinden oder Workflows mit der Speakap API automatisieren möchten. Er verweist auf die offizielle Entwicklerdokumentation und gibt einen Überblick über die Möglichkeiten der API.
Wo Sie die technische Dokumentation finden
Der wichtigste Ort für die Planung, den Aufbau und die Bereitstellung benutzerdefinierter Integrationen ist das Speakap Entwicklerportal unter developer.speakap.io. Dort können Sie Live-Beispieldaten durchsuchen, aktuelle Endpunktpfade einsehen und Code-Tutorials folgen.
Kernfunktionen der Speakap API
Das Entwicklerportal bietet umfangreiche, interaktive Referenzen für unsere RESTful Public API. Sie können es verwenden, um bidirektionale Datensynchronisationen über die Kernelemente in Speakap zu erstellen:
- Benutzer: Benutzerinformationen bereitstellen, eindeutige 64-Bit hexadezimale Identifikatoren (EIDs) abrufen und Mitarbeiterprofile prüfen. Hinweis: Ein EID ist nicht dasselbe wie ein XID. Ein EID ist der interne Bezeichner, der innerhalb von Speakap verwendet wird, während ein XID der externe Bezeichner ist, der einen Benutzer in Speakap mit einem externen System, wie einer HR-Datenbank, verknüpft.
- Gruppen: Ordnen Sie grundlegende, eingeschränkte, private oder hierarchische Organisationsgruppen zu, um Ihre interne Unternehmensstruktur abzubilden.
- Nachrichten: Abfragen von Ressourcen wie Aktualisierungen im Feed, Kommentaren, privaten Chatnachrichten, Nachrichtenartikeln und Datei-Uploads.
- Benachrichtigungen: Senden Sie benutzerdefinierte Push-Benachrichtigungen und lösen Sie Benutzerwarnungen aus, wenn wichtige Ereignisse in Drittanbietersystemen auftreten.
Authentifizierung, Manifeste und App-Bereitstellung
Zum Schutz der Daten Ihres Netzwerks vor unbefugter Nutzung verbinden sich alle benutzerdefinierten Funktionen über standardisierte Sicherheits- und Konfigurationsebenen:
- OAuth 2.0: Anwendungen autorisieren Anfragen mit kurzlebigen Access Tokens und langfristigen Refresh Tokens, verwaltet über den zentralen Speakap Authenticator.
- JSON-Anwendungsmanifeste: Entwickler definieren Integrationspunkte, Berechtigungssets und UI-Platzierung durch das Hochladen einer standardisierten manifest.json-Definitionsdatei.
- Der Speakap Market: Sobald ein internes Tool verifiziert ist, kann ein Netzwerkadministrator sich in einem Desktop-Browser anmelden und die Anwendung über den App Market-Tab in den Netzwerkeinstellungen installieren. Die App kann nur für die eigene Organisation sichtbar sein oder global im öffentlichen Speakap Market veröffentlicht werden.
Häufig gestellte Fragen
Wo finde ich die offizielle Speakap API-Dokumentation und die OpenAPI-Spezifikationen?
Sie können die Endpunktschemata erkunden und die neueste Version unserer öffentlichen OpenAPI-Definition im Speakap Entwicklerportal herunterladen.
Welchen Authentifizierungsstandard verwendet die Plattform zur Sicherung von Drittanbieter-Integrationen?
Speakap verwendet das branchenübliche OAuth 2.0-Protokoll in Kombination mit signierten Anfragen, um Client-Verbindungen sicher zu authentifizieren und Tokens zu übermitteln, die API-Aktionen im Namen von Apps oder Benutzern identifizieren.
Wie stelle ich eine benutzerdefinierte Anwendung in unserem Netzwerk bereit?
Erstellen Sie Ihre Anwendung gemäß den JSON-App-Manifest-Richtlinien im Entwicklerportal. Sobald sie bereit ist, kann ein Netzwerkadministrator sich in einem Desktop-Browser anmelden und sie über den App Market-Tab in den Netzwerkeinstellungen installieren.
Was sind EIDs und wie werden sie verwendet?
Ein EID ist ein interner Bezeichner, dargestellt als eindeutige hexadezimale 64-Bit-Ganzzahl, die jedem einzelnen Objekt in der Systemdatenbank zugewiesen wird. Sie übergeben diese EIDs in Ihren API-Anfrageheadern und Abfrageparametern, um Elemente wie bestimmte Benutzerprofile oder Nachrichtenartikel abzurufen oder zu aktualisieren. Im Gegensatz dazu ist ein XID der externe Bezeichner, der einen Benutzer in Speakap mit einem externen System, wie einer HR-Datenbank, verknüpft.
Immer noch Fragen?
Schreiben Sie uns eine E-Mail an technicalimplementations@speakap.nl mit dem Namen Ihres Netzwerks und einer Beschreibung dessen, was Sie erstellen, und wir helfen Ihnen weiter.