Zusammenfassung: Diese Anleitung erklärt, wie bestehende oder benutzerdefinierte Software mithilfe der Speakap API in Ihr Netzwerk integriert wird. Sie behandelt die technische Einrichtung für Entwickler (die manifest.json-Datei) und Schritt-für-Schritt-Anweisungen für Netzwerkadministratoren zur Installation einer App und deren Zuordnung zu bestimmten Gruppen. Weitere Informationen finden Sie unter developer.speakap.io.
Was ist eine Speakap-Anwendung?
Eine Speakap-Anwendung ist eine Webanwendung, die typischerweise von einem Drittanbieter bereitgestellt oder individuell entwickelt wird und in die Speakap-Plattform integriert ist, um bestimmte Funktionen bereitzustellen (z. B. eine To-Do-Liste oder eine Arbeitsplan-Software).
Benutzer greifen über die Speakap-Web- oder Mobil-Apps auf die Anwendung zu, wo sie in einem HTML-iframe eingebettet ist. Nach der Integration können Entwickler verschiedene Teile des Netzwerks nutzen:
- Der Feed und Widgets: Apps können automatisierte Updates in Feeds posten oder benutzerdefinierte Widgets anzeigen (zum Beispiel die To-Do-Liste des angemeldeten Benutzers) neben dem Netzwerk-Feed.
- Das Hauptmenü: Apps können direkt zum Hauptnavigationsmenü mit einem benutzerdefinierten Label und Icon (unter Verwendung des Font Awesome Icon-Sets) hinzugefügt werden.
- Benutzer und Gruppen: Apps können Benutzerdaten (Namen, Avatare, Berufsbezeichnungen) und Gruppendaten verwenden, um die Zusammenarbeit zu erleichtern.
Für Entwickler: Einrichten und Konfigurieren des Manifests
Bevor ein Administrator die App installieren kann, muss der Entwickler die Anwendung konfigurieren.
Schritt 1: Registrierung. Stellen Sie zunächst sicher, dass Sie Zugriff auf ein Speakap-Netzwerk haben. Registrieren Sie sich als Entwickler, um den Speakap Market-Tab in Ihren Netzwerkeinstellungen verfügbar zu machen.
Schritt 2: Konfigurieren der manifest.json. Jede Anwendung benötigt eine manifest.json-Datei, die Metadaten über die Anwendung angibt. Die allgemeinsten Informationen umfassen den Namen und das Icon, die verwendet werden, um die Anwendung im Speakap Market aufzulisten.
Der Kern des Manifests besteht aus den Definitionen der Einträge. Mindestens ein Eintrag muss angegeben werden, damit die App für Benutzer sichtbar ist. Einträge bestehen aus:
- Positionen: wo die App erscheint. Optionen sind main (das linke Menü), network-timeline-widget (Widgets auf der Desktop-Startseite), install-wizard (wird Admins während der Installation angezeigt), settings-page (für die Konfiguration nach der Installation) und *-lightbox (zum Laden benutzerdefinierter Lightbox-Inhalte).
- Geräte: die Formfaktoren, auf die sich der Eintrag bezieht (Telefon, Tablet, Desktop oder alle).
- Eigenschaften: Sie können die URL (geladen über eine signierte Anfrage), erforderliche Berechtigungen, das benutzerseitig sichtbare Label (das Übersetzungen wie „en-US“ enthalten sollte) und das Icon definieren.
Für die vollständige Vorlage und eine Referenz aller Eigenschaften siehe Speakap Application Manifest Template and Properties.
Für Administratoren: Installation der Anwendung
Sobald der Entwickler die Anwendung und die manifest.json-URL vorbereitet hat, kann ein Netzwerkadministrator sie installieren. Um den Speakap Market zu betreten, benötigen Sie ein aktives Speakap-Konto mit Administratorrolle.
- Melden Sie sich in Ihrem Speakap-Netzwerk an.
- Klicken Sie oben rechts auf der Seite auf Ihr Profilfoto.
- Klicken Sie auf Netzwerkeinstellungen und dann im Menü links auf Speakap Market.
- Klicken Sie oben rechts auf + Anwendung.
- Wählen Sie Ihre gewünschte Anwendung aus der Liste aus oder kopieren Sie die manifest.json-Datei Ihrer benutzerdefinierten App hinein.
- Klicken Sie auf Anwendung hinzufügen.
- Klicken Sie auf Im Netzwerk installieren, um die Anwendung zu installieren.
Zuweisung der Anwendung zu bestimmten Gruppen. Anwendungen können für das gesamte Netzwerk oder für bestimmte Zielgruppen wie Geschäftseinheiten, Abteilungen oder Gruppen installiert werden:
- Wenn die Anwendung nur für bestimmte Mitglieder sichtbar sein soll, klicken Sie bei Schritt 7 oben auf Gruppen auswählen.
- Wählen Sie im Bildschirm „Gruppen auswählen“ die spezifische Zielgruppe für die Anwendung aus.
- Klicken Sie nach der Auswahl der gewünschten Gruppen zur Bestätigung auf Auswählen.
Verwaltung installierter Anwendungen
Administratoren können Speakap-Anwendungen jederzeit im Speakap Market, der sich in den Netzwerkeinstellungen befindet, aktivieren, deaktivieren oder bearbeiten. Wenn der Speakap Market nicht sichtbar ist, wenden Sie sich an Ihren Customer Success Manager (csm@speakap.com) oder senden Sie eine E-Mail an support@speakap.com, um ihn für Sie freizuschalten.
Einige Anwendungen verfügen, abhängig von ihrer Bauweise, über eine Einstellungsschaltfläche (Zahnrad neben dem Papierkorb). Klicken Sie darauf, um die Einstellungen der App zu bearbeiten. Bei Fragen zu den Einstellungen einer Anwendung wenden Sie sich bitte an den Entwickler dieser Anwendung.
Um eine Anwendung später zu entfernen, siehe Wie man eine Anwendung aus dem Speakap Market entfernt.
Immer noch Probleme?
Schreiben Sie uns eine E-Mail an support@speakap.com mit Ihrem Netzwerknamen und dem Namen der Anwendung, und wir helfen Ihnen weiter. Für technische Fragen zur API oder Ihrer manifest.json senden Sie bitte eine E-Mail an technicalimplementations@speakap.nl.