Erste Schritte mit Adobe Connect Web Services

Für den Einstieg in Adobe Connect Web Services müssen Sie sich mit drei Hauptkonzepten vertraut machen:

• Prinzipale, also Benutzer und Gruppen

• SCOs, also Shareable Content Objects für Meetings, Kurse und unzählige weitere Inhalte, die auf Adobe Connect erstellt werden können. SCOs (ausgesprochen Sko, der sich mit schneien) sind mit der branchenüblichen SCORM-Spezifikation (Shareable Content Object Reference Model) kompatibel und können mit einem Learning Management System (LMS) verwendet werden.

• Berechtigungen, also die Aktionen, die die Prinzipale für Objekte ausführen können

In diesem Kapitel werden die grundlegenden Aufgaben beschrieben, die Sie mit Web Services erledigen können, unabhängig von den Adobe Connect-Anwendungen, für die Sie eine Lizenz besitzen. Bei vielen Aufgaben wird erläutert, wie Sie sie in einem Browser ausführen. Wenn Sie den Aufruf von einer Anwendung aus vornehmen möchten, übersetzen Sie die XML-Anforderung in Ihre Arbeitssprache (ein Beispiel für Java™ finden Sie unter Senden von XML-Anforderungen).

Ein Prinzipal ist ein Benutzer oder eine Gruppe mit einer definierten Berechtigung für die Interaktion mit einem SCO auf dem Server. Sie können Benutzer und Gruppen für Ihre Organisation erstellen und deren Berechtigungen ändern.

Adobe Connect bietet auch integrierte Gruppen: Administratoren, begrenzte Administratoren, Autoren, Schulungsverwalter, Veranstaltungsverwalter, Teilnehmer, Meetingveranstalter und Seminarveranstalter. Sie können integrierten Gruppen Benutzer und Gruppen hinzufügen, aber die Berechtigungen integrierter Gruppen nicht ändern.

Jeder Adobe Connect-Benutzer und jede Gruppe verfügt über eine principal-id. In einigen API-Aufrufen wird das Attribut principal-id als group-id oder user-id bezeichnet, damit es von anderen Werten unterschieden werden kann. Der Wert der ID eines Benutzers oder einer Gruppe ist immer gleich, unabhängig vom Namen.

Die principal-id eines Benutzers oder einer Gruppe abrufen

Die principal-id des aktuellen Benutzers abrufen

Prinzipale oder Gäste auflisten

Ein Prinzipal mit dem Wert user für type ist ein registrierter Adobe Connect-Benutzer, ein Benutzer mit dem Wert guest für type hat dagegen einen Meetingraum als Gast betreten. Der Server erfasst Informationen zum Gast und weist dem Gast eine principal-id zu.

Alle Prinzipale auf dem Server auflisten

Alle Gäste auf dem Server auflisten

Alle Benutzer auflisten, die einem bestimmten Verwalter unterstellt sind

Wenn Sie principal-info mit einer principal-id aufrufen, zeigt die Antwort den Prinzipal. Wenn der Prinzipal als Benutzer fungiert, dem ein Verwalter in Adobe Connect zugewiesen ist, zeigt die Antwort auch Daten zum Verwalter des Prinzipals in einem manager-Element:

Sie können die principal-id des Verwalters in principal-list angeben und damit alle Benutzer abrufen, die dem Verwalter zugewiesen sind.

Erstellen von Benutzern

Zum Erstellen eines neuen Benutzers benötigen Sie Administratorrechte. Adobe empfiehlt, einen Benutzer zu erstellen, der zur admins-Gruppe für Ihre Anwendung gehört, und mit diesem Benutzer die API-Aufrufe auszuführen, für die Administratorrechte erforderlich sind.

Einen neuen Benutzer erstellen und eine Begrüßungs-E-Mail senden

Einen neuen Benutzer ohne Angabe einer E-Mail-Adresse als Anmelde-ID erstellen

Benutzer aktualisieren

Die Informationen der erstellten Benutzer müssen häufig nachträglich aktualisiert werden. Sollen die Standardfelder aktualisiert werden, die Adobe Connect für die Benutzer definiert, rufen Sie principal-update mit der principal-id des Benutzers auf. Die Standardfelder umfassen email, login, first-name und last-name.

Wenn Sie benutzerdefinierte Felder für den Prinzipal definiert haben, aktualisieren Sie diese Felder mit acl-field-update.

Zum Aktualisieren der Benutzer benötigen Sie Administratorrechte. Ihre Anwendung muss sich daher zuerst als Benutzer bei der admins-Gruppe anmelden. Sie können sich nicht als der betreffende Benutzer anmelden und den Benutzer dann das eigene Profil aktualisieren lassen.

Standardbenutzerinformationen aktualisieren

Benutzerdefinierte Feldwerte für einen Benutzer aktualisieren

Erstellen von benutzerdefinierten Feldern

Benutzerdefinierte Felder sind zusätzliche Datenfelder, die Sie definieren. Mit custom-field-update können Sie bis zu acht benutzerdefinierte Felder für einen Prinzipal oder ein SCO definieren.

Wenn Sie ein benutzerdefiniertes Feld definiert haben, können Sie dessen Wert standardmäßig entweder in Adobe Connect Central bearbeiten oder custom-field-update aufrufen und den Wert dort festlegen.

Soll der Wert nur über die API aktualisiert werden, rufen Sie custom-field-update mit dem Parameter object-type=object-type-read-only auf.

Ein benutzerdefiniertes Feld definieren und für einen Benutzer festlegen

Gruppen erstellen

Zum Hinzufügen von Benutzern zu Gruppen müssen Sie principal-update als Administratorbenutzer Ihrer Anwendung aufrufen.

Einen Benutzer zu einer Gruppe hinzufügen

Überprüfen, ob ein bestimmter Benutzer zu einer Gruppe gehört

Überprüfen, welche Benutzer zu einer Gruppe gehören

Alle Gruppen auflisten, zu denen ein Benutzer gehört

SCOs suchen

Alle Objekte in Adobe Connect sind Shareable Content Objects oder kurz SCOs. Das Wort Shareable stammt aus Lernmanagementsystemen, in denen Inhalte zu Kurse oder Lehrpläne kombiniert und zwischen den Kursen oder Lehrplänen ausgetauscht werden.

Auf dem Server kann ein SCO ein beliebiges Inhaltsobjekt sein, das mit anderen Inhaltsobjekten zu einem Kurs oder Studienplan kombiniert wird. Kurse, Lehrpläne, Präsentationen und andere Inhaltstypen sind SCOs. Meetings, Veranstaltungen, Ordner, Strukturen, Links, Grafikdateien und andere Objekte sind ebenfalls SCOs.

Jedes SCO weist eine eindeutige Ganzzahlkennung auf, eine sogenannte sco-id. Die sco-id ist auf dem gesamten Server eindeutig. Bei einem gehosteten Konto von Adobe Connect ist die sco-id in allen Konten eindeutig.

Jedem SCO ist außerdem ein Typ zugewiesen, z. B. content, course, meeting usw. Die Werte für sco-id und type finden Sie in der Antwort aus sco-info oder anderen Aktionen:

Merkmale von SCOs

Wenn Sie die XML-Antworten verschiedener Aufrufe näher betrachten, fallen weitere Merkmale von SCOs ins Auge:

• Die Kennung einer SCO wird in einigen Aktionen als sco-id bezeichnet, kann in anderen Aktionen aber auch als folder-id, acl-id oder ein anderer Name angegeben sein. Dies ist jeweils dieselbe eindeutige ID.

• Auf jedes SCO können verschiedene Prinzipale zugreifen, entweder Benutzer oder Gruppen. Die jeweiligen Prinzipale, die auf ein SCO zugreifen können, werden in Zugriffssteuerungslisten oder ACLs definiert.

• Jedes SCO hat eine eindeutige URL, die sich aus zwei Teilen zusammensetzt: einem Domänennamen (wie http://example.com) und einem URL-Pfad (wie /f2006123456/). Wenn Sie diese Teile verketten, entsteht die vollständige URL für den Zugriff auf das SCO.

• Für jedes SCO gilt ein Navigationspfad, der die Position des SCO in der Ordnerhierarchie beschreibt.

• Bei jedem SCO ist eine Berechtigung für jeden Prinzipal definiert, der darauf zugreifen kann.

• Bestimmte SCOs umfassen Beschreibungsfelder mit Textzeichenfolgen, die Informationen über die SCO enthalten.

Sie müssen häufig die ID eines SCO oder andere Informationen darüber ermitteln. SCOs sind in einer bestimmten Ordnerhierarchie angeordnet. Aus den Namen der Ordner geht hervor, ob sie sich auf der obersten Ebene befinden und ob sie freigegebene oder benutzereigene Inhalte oder Vorlagen.

Wenn Sie sco-shortcuts aufrufen, wird eine Liste mit Ordnern zurückgegeben. Die Ordner weisen unterschiedliche Typen auf:

Die in diesem Beispiel gezeigten Ordner sind für Meetings vorgesehen; die Ordner für andere SCO-Arten sind ähnlich aufgebaut. In jedem Ordnertyp werden bestimmte Objekttypen mit bestimmten Zugriffsrechten gespeichert:

Dies sind freigegebene Ordner, z. B. „Gemeinsame Meetings“, „Gemeinsame Schulung“ usw. Der Adobe Connect-Administrator hat Zugriff auf diesen Ordner. Der Administrator kann jedem Benutzer Verwaltungsberechtigungen zuweisen, aber nur Mitglieder der integrierten Gruppe, die dem Ordner zugeordnet ist, können neue Inhalte oder Meetings in diesem Ordner erstellen.

Diese Ordner enthalten jeweils einen Ordner für jeden Benutzer, der Inhalte darin erstellen kann (z. B. einen Ordner für jeden Meetingveranstalter oder Schulungsentwickler).

Benutzer erstellen ihre eigenen Inhalte in diesen Ordnern und besitzen Verwaltungsberechtigungen für den Inhalt. Meetingveranstalter erstellen beispielsweise Meetings in ihrem Ordner my-meetings und besitzen Verwaltungsberechtigungen für diese Meetings.

Dieser Ordner befindet sich im Ordner „Freigegebene Meetings“, enthält Meetingvorlagen und erbt Berechtigungen von „Freigegebene Meetings“.

Sie können den Inhalt eines beliebigen Ordners auflisten und Informationen zu einem bestimmten SCO ermitteln. Wenn Sie nach einem SCO suchen müssen, aber die sco-id nicht kennen, navigieren Sie mit sco-shortcuts und sco-expanded-contents durch die Ordner. sco-search gibt nur bestimmte SCO-Typen zurück und sollte daher nicht verwendet werden.

Ein SCO suchen, wenn die sco-id bekannt ist

Informationen zu einem SCO abrufen

URL für ein SCO erstellen

Dateien herunterladen

Sie können ZIP-Dateien aus Adobe Connect auf den lokalen Computer eines Benutzers herunterladen. Eine ZIP-Datei ist ein SCO. Zum Herunterladen müssen Sie eine Download-URL für die ZIP-Datei erstellen, die in etwa wie folgt aussieht:

Der Domänenname Ihres Servers ist Ihnen in der Regel bekannt (z. B. example.com). Falls nicht, rufen Sie ihn mit sco-shortcuts ab.

Eine ZIP-Datei vom Server herunterladen

Prüfen Sie die Berechtigungen

Berechtigungen definieren, wie ein Prinzipal mit einem SCO interagieren kann.

Eine Berechtigungszuordnung, die die Berechtigungen eines Prinzipals für ein bestimmtes SCO angibt, wird als Zugriffssteuerungsliste oder ACL bezeichnet. Eine ACL umfasst drei Informationen:

• Die ID eines Prinzipals (eine principal-id).

• Die ID eines SCO, Kontos oder Prinzipals, für das bzw. den Aktionen ausgeführt werden. In Berechtigungsaufrufen ist dies dieacl-id. In anderen Aufrufen kann die ID als sco-id, account-id oder principal-id bezeichnet werden.

• Ein Schlüsselwort für die Berechtigungsebene des Prinzipals (einer der gültigen Werte in permission-id).

Berechtigung eines Prinzipals für ein SCO überprüfen

Berechtigungen alle Prinzipale für ein SCO überprüfen