Lizenzieren von Office- und SharePoint-Add-Ins

Office and SharePoint Add-ins

Verwenden Sie das Add-In-Lizenzframework für Office- und SharePoint-Add-Ins, um die rechtmäßige Nutzung Ihrer Add-Ins zu prüfen und durchzusetzen, die aus dem Office Store heruntergeladen werden.

Das Lizenzframework für Office- und SharePoint-Add-Ins ermöglicht es Ihnen, Code in Ihre Add-Ins einzufügen, der die rechtmäßige Nutzung der Add-Ins prüft und durchsetzt. Sie können den Zugriff auf Ihre Add-Ins auf Benutzer mit gültiger Lizenz beschränken oder angeben, welche Features verfügbar sind, wie sich die Add-Ins verhalten, oder weitere Logik basierend auf den Eigenschaften der Lizenz angeben. Wenn Sie beabsichtigen, Ihr Add-In zu verkaufen, sollten Sie eine Logik integrieren, die anhand des Lizenzframeworks ermittelt, ob ein Benutzer über eine gültige Lizenz für das Add-In verfügt. Zudem kann der Benutzer je nach den Lizenzeigenschaften Zugriff auf die Add-In-Funktionen erhalten.

Das Add-In-Lizenzframework selbst erzwingt keine Add-In-Lizenzen. Es stellt lediglich die Struktur dar, in der Sie Ihren Add-Ins Code hinzufügen können, der abgerufen und auf Lizenzinformationen angewendet wird.

Das Add-In-Lizenzframework gilt nur für Add-Ins, die direkt vom Office Store bezogen werden, oder Add-Ins aus dem Office Store, die in einem in SharePoint 2013 gehosteten Add-In-Katalog angeboten werden. Auf andere Weise verfügbar gemachte Add-Ins, beispielsweise von einem Dateisystemspeicherort aus oder durch direktes Hochladen in einen auf SharePoint gehosteten Add-In-Katalog, können das Lizenzframework nicht verwenden.

Das Add-In-Lizenzframework für Office und SharePoint 2013 umfasst:

  • Den Office Store – eine Website, auf der Benutzer lizenzierte Office- und SharePoint-Add-Ins erwerben können. Der Office Store wickelt die Bezahlung ab und gibt Lizenzen aus.

  • Speicherung von Lizenzen und Erneuerung von Add-In-Lizenztoken

  • APIs, die Sie zum Abrufen von Lizenzinformationen verwenden können

  • Einen Webdienst, mit dem Sie die Gültigkeit einer Lizenz prüfen können

  • Speziell für SharePoint-Add-Ins bietet SharePoint 2013 eine Benutzeroberfläche für die Add-In-Lizenzverwaltung. Mit ihr kann ein Add-In-Käufer die Lizenz einem Benutzer zuweisen und außerdem die Verwaltung der Lizenz an andere Benutzer delegieren.

  • Speziell für Outlook-Add-Ins (Weberweiterungen) bietet Exchange 2013 die Exchange-Verwaltungskonsole, über die Administratoren Outlook-Add-Ins für ihre Organisation erwerben und verwalten können.

Das Add-In-Lizenzframework bietet Ihnen eine Möglichkeit, den Add-In-Zugriff und das Add-In-Verhalten auf Basis von Lizenzinformationen anzupassen. Nachfolgend wird die Durchführung von Add-In-Lizenzüberprüfungen in groben Zügen beschrieben.

Entwerfen der Add-In-Benutzererfahrung unter Berücksichtigung der Lizenzierung

Wenn Sie das Lizenzframework verwenden möchten, sollten Sie dies beim Entwurf Ihres Add-Ins berücksichtigen. Entscheiden Sie, welche Benutzererfahrung Sie auf Basis von Lizenzinformationen steuern oder anpassen möchten. Möglicherweise möchten Sie Folgendes tun:

  • Immer wenn der Benutzer das Add-In startet überprüfen, ob der Benutzer eine gültige Lizenz besitzt

  • Nur bestimmte Funktionen in Ihrem Add-In verfügbar machen, wenn der Benutzer eine Testlizenz besitzt

  • Dem Benutzer bei Aufgabenbereich- und Inhalts-Add-Ins abhängig davon, ob der Benutzer Ihr Add-In anonym aufruft oder mit einer gültigen Lizenz angemeldet ist, eine andere Oberfläche bieten

Hinzufügen von Lizenzüberprüfungen zu Ihrem Add-In-Code

Fügen Sie für jede Benutzererfahrung, die Sie basierend auf Lizenzinformationen anpassen möchten, Code für das Ereignis hinzu, der eine Lizenzüberprüfung durchführt. Bei der Lizenzüberprüfung wird ermittelt, ob der Lizenztoken vorhanden ist, und wenn ja, wird er validiert.

Abrufen des Lizenztoken, falls vorhanden

Ihr Lizenzüberprüfungscode sollte ermitteln, ob der Add-In-Lizenztoken vorhanden ist, und diesen ggf. abrufen.

  • Wenn das Add-In gestartet wird und die Office-Anwendung die Add-In-Startseite abruft, übergibt die Office-Anwendung das Lizenztoken bei Inhalts- und Aufgabenbereich-Office-Add-Ins als Abfrageparameter in der HTTP-Anforderung. Der Add-In-Code muss diese Daten extrahieren und zwischenspeichern, damit der Lizenzprüfcode im Add-In später darauf zugreifen kann.

    Wenn der Benutzer nicht bei seinem Microsoft-Konto angemeldet ist, hängt die Office-Anwendung, welche die Add-In-Startseite anfordert, den Lizenztokenparameter nicht an. Weitere Informationen finden Sie unter Add-In-Lizenztoken und anonymer Zugriff für Office-Add-Ins.

  • Bei kostenpflichtigen Outlook-Add-Ins fügt Exchange die URL des Quellspeicherorts der App mit einem Lizenztoken als Abfrageparameter der URL an und überträgt das Add-In-Manifest dann an Outlook. Beim Starten des Add-Ins übergibt Outlook das Lizenztoken als Abfrageparameter in der HTTP-Anforderung. Der Add-In-Code muss diese Daten extrahieren und zwischenspeichern, damit der Lizenzprüfcode im Add-In später darauf zugreifen kann.

  • Bei SharePoint-Add-Ins fragt der Lizenzprüfcode der App die SharePoint-Bereitstellung nach dem Lizenztoken ab.

Add-In-Lizenztoken und anonymer Zugriff für Office-Add-Ins

Um die Reichweite und Akzeptanz Ihrer Add-Ins zu maximieren, erfordert Microsoft ab Office 2013, Service Pack 1, nicht mehr, dass ein Benutzer mit seinem Microsoft-Konto bei Office angemeldet ist, um Office-Add-Ins zu aktivieren. Ab Office 2013, Service Pack 1, wird der Add-In-Lizenztoken im Rahmen der ursprünglichen HTTP-Anforderung nur übergeben, wenn der Benutzer mit seinem Microsoft-Konto angemeldet ist.

Wenn der Benutzer nicht bei seinem Microsoft-Konto angemeldet ist, hängt die Office-Anwendung, welche die Add-In-Startseite anfordert, den Lizenztokenparameter nicht an. Daher müssen Sie in Ihr Add-In Code einschließen, der festlegt, ob der Lizenztoken in jeder HTTP-Anforderung für die Startseite der App vorhanden ist. Ist dies nicht der Fall, kann Ihr Add-In die Anforderung als von einem anonymen Benutzer kommend behandeln, und die Benutzeroberfläche und die Funktionen anzeigen, die Sie für angemessen halten. So könnte Ihr Add-In z. B. Benutzeroberfläche anzeigen, die mehr Informationen zu Ihrem Add-In bietet, einen Link zum Eintrag Ihres Add-Ins im Office Store, einen reduzierten Satz von Funktionen oder andere relevante Angaben.

Add-In-Lizenztyp

Empfohlene UX, wenn der Benutzer anonym ist (Lizenztoken nicht vorhanden)

Kostenlos

Keine Änderungen im Verhalten, Add-In kann auf gleiche Weise verwendet werden. Wenn Sie allerdings den Lizenztoken verwenden, um die Benutzeridentität Ihres kostenlosen Add-Ins zu ermitteln, sollten Sie dem Benutzer einen Hinweis anzeigen und ihn auffordern, sich mit einem Microsoft-Konto bei Office anzumelden, um von sämtlichen Vorteilen Ihres Add-Ins profitieren zu können.

Test

Zeigen Sie die Test-Add-In-Benutzeroberfläche an, wenn der Benutzer anonym ist. Wenn Sie den Lizenztoken verwenden, um die Benutzeridentität Ihres kostenlosen Add-Ins zu ermitteln, sollten Sie dem Benutzer einen Hinweis anzeigen und ihn auffordern, sich mit einem Microsoft-Konto bei Office anzumelden, um von sämtlichen Vorteilen Ihres Add-Ins profitieren zu können.

Kostenpflichtig

Wenn Ihr Add-In nur kostenpflichtige Lizenzen unterstützt (d. h. wenn Sie kein Test-Add-In anbieten), sollten Sie dem Benutzer anstatt eines funktionsfähigen Add-Ins Informationen zu Ihrem Add-In anzeigen, einschließlich eines Links zur Office Store-Seite, auf der Ihr Add-In aufgelistet wird. So werden Benutzer auf Ihr Add-In aufmerksam und zum Kauf des Add-Ins ermuntert.

Wenn Ihr Aufgabenbereich- oder Inhalts-Add-In diese Lizenzüberprüfung nicht durchführt, zeigt Ihr Add-In anonymen Benutzern standardmäßig die gleiche Benutzeroberfläche und die gleichen Funktionen wie lizenzierten Benutzern an.

Validieren der Lizenz

Nachdem das Add-In das Add-In-Lizenztoken erhalten hat, übergibt das Add-In es an den Überprüfungswebdienst des Office Store, damit dieser prüft, ob die Lizenz gültig ist und die darin enthaltenen Informationen korrekt sind. Der Überprüfungsdienst antwortet, ob das Lizenztoken gültig ist, und gibt die Lizenzattributwerte zurück. Je nach Gültigkeit der Lizenz und den Lizenzinformationen kann der Add-In-Code dann die entsprechende Aktion einleiten.

Der Überprüfungsdienst von Office Store kann nicht von clientseitigem Code aufgerufen werden.

  • Für Office-Add-Ins müssen Sie serverseitigen Code verwenden, um den Überprüfungswebdienst von Office Store abzufragen.

  • Wenn Sie Ihre Add-In-Seiten auf SharePoint hosten, können Sie für SharePoint-Add-Ins den SharePoint-Webproxy verwenden, um JavaScript-Aufrufe an den Überprüfungsdienst von Office Store zu übermitteln. Aus Sicherheitsgründen raten wir jedoch dringend dazu, nur serverseitigen Code für Abfragen an den Überprüfungswebdienst von Office Store zu verwenden.

Einleiten von Aktionen auf Basis von Lizenzeigenschaften

Fügen Sie Ihre-Add-In abschließend Code hinzu, welcher die erwünschten Aktionen auf Basis der Eigenschaften der Add-In-Lizenz des Benutzers einleitet. So könnte etwa je nach Abonnementstatus eine andere Benutzeroberfläche angezeigt werden, bei Testlizenzen könnten bestimmte Funktionen deaktiviert werden, oder Sie könnten basierend auf den Lizenzinformationen beliebige andere Anpassungen vornehmen.

Abläufe für Abfrage und Validierung von Add-In-Lizenzen

Die folgende Abbildung veranschaulicht den Abfrage- und Validierungsprozess von Add-In-Lizenzen für Office-Add-Ins.

Hinweis Hinweis

Aufgabenbereich- und Inhalts-Add-Ins ermöglichen anonymen Zugriff. Wenn der Benutzer nicht bei seinem Microsoft-Konto angemeldet ist, hängt die Office-Anwendung, welche die Add-In-Startseite anfordert, den Lizenztokenparameter nicht an. Weitere Informationen finden Sie unter Add-In-Lizenztoken und anonymer Zugriff für Office-Add-Ins.

Prozess der Lizenzüberprüfung einer Office-App
  1. Der Benutzer startet das Add-In.

  2. Die Office-Anwendung, welche das Add-In hostet, fordert die Startseite an.

  3. Die Office-Anwendung hängt den Add-In-Lizenztoken als einen Abfragezeichenfolgen-Parameter an die HTTP-Anforderung an.

  4. Der Add-In-Code extrahiert den Lizenztoken und speichert ihn zwischen.

  5. Wenn das Add-In den Lizenztoken überprüfen muss, verwendet es serverseitigen Code, um den Token an den Office Store-Überprüfungsdienst zu übergeben.

  6. Der Überprüfungsdienst gibt zurück, ob der Lizenztoken gültig ist. Wenn ja, gibt er auch die Lizenzeigenschaften zurück.

  7. Je nach Gültigkeit der Lizenz und den Eigenschaften kann das Add-In dann die entsprechende Aktion einleiten.

Die folgende Abbildung veranschaulicht den Abfrage- und Validierungsprozess von Add-In-Lizenzen für SharePoint-Add-Ins.

Überprüfungsprozess der SharePoint-App-Lizenz
  1. Der Benutzer startet das Add-In in SharePoint.

  2. Damit wird der Add-In-Code in der Cloud gestartet.

  3. Wenn das Add-In die Add-In-Lizenz eines Benutzers überprüfen muss, verwendet es serverseitigen Code, um den Add-In-Lizenztoken über das Clientobjektmodell von SharePoint abzufragen.

  4. Anschließend übergibt sie den Token an den Office Store-Überprüfungsdienst.

  5. Der Überprüfungsdienst gibt zurück, ob der Lizenztoken gültig ist. Wenn ja, gibt er auch die Lizenzeigenschaften zurück.

  6. Je nach Gültigkeit der Lizenz und den Eigenschaften kann das Add-In dann die entsprechende Aktion einleiten.

Anzeigen: