Samenvatting: Deze gids is bedoeld voor ontwikkelaars, IT-architecten en systeemintegratoren die aangepaste applicaties willen bouwen, externe software willen koppelen of workflows willen automatiseren met de Speakap API. Het verwijst je naar de officiële ontwikkelaarsdocumentatie en geeft een overzicht van wat de API kan doen.
Waar vind je de technische documentatie
De belangrijkste plek voor het plannen, bouwen en implementeren van aangepaste integraties is de Speakap Developer Portal op developer.speakap.io. Daar kun je live voorbeeldpayloads bekijken, up-to-date endpoint-paden inzien en code tutorials volgen.
Kernmogelijkheden van de Speakap API
De developer portal biedt uitgebreide, interactieve referenties voor onze RESTful openbare API. Je kunt deze gebruiken om bidirectionele datasynchronisaties te bouwen over de kernobjecten in Speakap:
- Gebruikers: Voorzie gebruikersgegevens, haal unieke 64-bits hexadecimale identificaties (EIDs) op en controleer medewerkersprofielen. Opmerking: een EID is niet hetzelfde als een XID. Een EID is de interne identifier die binnen Speakap wordt gebruikt, terwijl een XID de externe identifier is die een gebruiker in Speakap koppelt aan een extern systeem, zoals een HR-database.
- Groepen: Koppel basis-, beperkte, privé- of hiërarchische organisatiegroepen om overeen te komen met je interne bedrijfsstructuur.
- Berichten: Raadpleeg bronnen waaronder updates op de Feed, reacties, privéchatberichten, nieuwsitems en bestandsuploads.
- Meldingen: Verstuur aangepaste pushmeldingen en activeer gebruikersalerts wanneer belangrijke gebeurtenissen plaatsvinden in systemen van derden.
Authenticatie, manifests en app-implementatie
Om de gegevens van je netwerk te beschermen tegen ongeoorloofd gebruik, verbinden alle aangepaste functies via standaard beveiligings- en configuratielagen:
- OAuth 2.0: Applicaties autoriseren verzoeken met behulp van kortdurende Access Tokens en langetermijn Refresh Tokens, beheerd via de centrale Speakap Authenticator.
- JSON applicatiemanifests: Ontwikkelaars definiëren integratiepunten, machtigingssets en UI-plaatsing door het uploaden van een standaard manifest.json-definitiebestand.
- De Speakap Market: Zodra een intern hulpmiddel is geverifieerd, kan een netwerkbeheerder inloggen op een desktopbrowser en de applicatie installeren via het tabblad App Market in Network Settings. De app kan alleen zichtbaar zijn voor je eigen organisatie, of wereldwijd worden gepubliceerd in de openbare Speakap Market.
Veelgestelde vragen
Waar kan ik de officiële Speakap API-documentatie en OpenAPI-specificaties vinden?
Je kunt de endpoint-schema’s verkennen en de nieuwste versie van onze openbare OpenAPI-definitie downloaden in de Speakap Developer Portal.
Welke authenticatiestandaard gebruikt het platform om integraties van derden te beveiligen?
Speakap gebruikt het industriestandaard OAuth 2.0-protocol in combinatie met ondertekende verzoeken om clientverbindingen veilig te authenticeren, waarbij tokens worden doorgegeven om API-acties namens apps of gebruikers te identificeren.
Hoe implementeer ik een aangepaste applicatie in ons netwerk?
Bouw je applicatie volgens de richtlijnen voor JSON-appmanifests op de developer portal. Zodra deze klaar is, kan een netwerkbeheerder inloggen op een desktopbrowser en deze installeren via het tabblad App Market in Network Settings.
Wat zijn EIDs en hoe worden ze gebruikt?
Een EID is een interne identifier die wordt weergegeven als een unieke hexadecimale 64-bits integer die aan elk individueel object in de systeemdatabase wordt toegewezen. Je levert deze EIDs in je API-verzoekheaders en queryparameters om items zoals specifieke gebruikersrecords of nieuwsitems op te zoeken of bij te werken. Daarentegen is een XID de externe identifier die wordt gebruikt om een gebruiker in Speakap te koppelen aan een extern systeem, zoals een HR-database.
Nog steeds vastgelopen?
Stuur ons een e-mail via technicalimplementations@speakap.nl met je netwerknaam en een beschrijving van wat je aan het bouwen bent, dan helpen we je verder.