Samenvatting: Deze gids legt uit hoe je bestaande of aangepaste software integreert in je netwerk met behulp van de Speakap API. Het behandelt de technische setup voor ontwikkelaars (het manifest.json-bestand) en stapsgewijze instructies voor netwerkbeheerders om een app te installeren en toe te wijzen aan specifieke groepen. Meer informatie vind je op developer.speakap.io.
Wat is een Speakap applicatie?
Een Speakap applicatie is een webapplicatie, meestal geleverd door een derde partij of op maat gebouwd, die wordt geïntegreerd in het Speakap platform om specifieke functionaliteit te bieden (zoals een takenlijst of werkrooster software).
Gebruikers openen de applicatie vanuit de web- of mobiele apps van Speakap, waar deze is ingebed in een HTML iframe. Zodra geïntegreerd, kunnen ontwikkelaars verschillende delen van het netwerk gebruiken:
- De Feed en widgets: apps kunnen geautomatiseerde Updates plaatsen in feeds of aangepaste widgets tonen (bijvoorbeeld een takenlijst van de ingelogde gebruiker) naast de netwerk Feed.
- Het hoofdmenu: apps kunnen direct worden toegevoegd aan het hoofd navigatiemenu met een aangepaste label en icoon (gebruikmakend van de Font Awesome iconenset).
- Gebruikers en groepen: apps kunnen gebruikersprofielgegevens (namen, avatars, functietitels) en groepsgegevens gebruiken om samenwerking te stroomlijnen.
Voor ontwikkelaars: het opzetten en configureren van het manifest
Voordat een beheerder de app kan installeren, moet de ontwikkelaar de applicatie configureren.
Stap 1: Registratie. Zorg er eerst voor dat je toegang hebt tot een Speakap netwerk. Registreer je als ontwikkelaar om het tabblad Speakap Market beschikbaar te maken in je netwerk instellingen.
Stap 2: Configureren van het manifest.json. Elke applicatie vereist een manifest.json-bestand, dat metadata over de applicatie specificeert. De meest algemene informatie omvat de naam en het icoon, die worden gebruikt om de applicatie in de Speakap Market te vermelden.
De kern van het manifest wordt gevormd door de definities van de entries. Er moet minstens één entry worden opgegeven zodat de app zichtbaar is voor gebruikers. Entries bestaan uit:
- Posities: waar de app verschijnt. Opties zijn main (het menu aan de linkerkant), network-timeline-widget (desktop homepage widgets), install-wizard (getoond aan admins tijdens installatie), settings-page (voor configuratie na installatie), en *-lightbox (voor het laden van aangepaste lightbox-inhoud).
- Apparaten: de formaten waarop de entry van toepassing is (telefoon, tablet, desktop, of alle).
- Eigenschappen: je kunt de url definiëren (geladen via een ondertekend verzoek), vereiste permissies, het voor gebruikers zichtbare label (dat vertalingen zoals "en-US" moet bevatten), en het icoon.
Voor het volledige sjabloon en een referentie van alle eigenschappen, zie Speakap Application Manifest Template and Properties.
Voor beheerders: het installeren van de applicatie
Zodra de ontwikkelaar de applicatie en de manifest.json URL heeft voorbereid, kan een netwerkbeheerder deze installeren. Om toegang te krijgen tot de Speakap Market heb je een actief Speakap account met een beheerdersrol nodig.
- Log in op je Speakap netwerk.
- Klik op je profielfoto rechtsboven op de pagina.
- Klik op Netwerkinstellingen, klik vervolgens op Speakap Market in het menu aan de linkerkant.
- Klik op + Applicatie rechtsboven in het scherm.
- Selecteer de gewenste applicatie uit de lijst, of kopieer en plak het manifest.json-bestand van je aangepaste app.
- Klik op Applicatie toevoegen.
- Klik op Installeren in netwerk om de applicatie te installeren.
De applicatie toewijzen aan specifieke groepen. Applicaties kunnen worden geïnstalleerd voor het hele netwerk of voor specifieke doelgroepen, zoals Business Units, Afdelingen of Groepen:
- Als je wilt dat de applicatie alleen zichtbaar is voor bepaalde leden, klik dan op Selecteer Groepen bij stap 7 hierboven.
- Selecteer in het scherm Selecteer Groepen de specifieke doelgroep voor de applicatie.
- Klik na het selecteren van de gewenste groepen op Selecteren om te bevestigen.
Beheren van geïnstalleerde applicaties
Beheerders kunnen Speakap applicaties op elk moment activeren, deactiveren of bewerken in de Speakap Market, te vinden in de Netwerkinstellingen. Als de Speakap Market niet zichtbaar is, vraag dan je Customer Success Manager (csm@speakap.com) of stuur een e-mail naar support@speakap.com om deze voor je te activeren.
Sommige applicaties, afhankelijk van hoe ze zijn gebouwd, hebben een instellingenknop (tandwiel naast de prullenbak). Klik hierop om de instellingen van de app te bewerken. Voor vragen over de instellingen van een applicatie neem je contact op met de ontwikkelaar van die applicatie.
Om een applicatie later te verwijderen, zie Hoe verwijder je een applicatie uit de Speakap Market.
Nog steeds vastgelopen?
Stuur ons een e-mail op support@speakap.com met je netwerknaam en de naam van de applicatie, dan helpen we je verder. Voor technische vragen over de API of je manifest.json, stuur een e-mail naar technicalimplementations@speakap.nl.