Utilisation des services Web d’Adobe® Connect™ Enterprise
Si le présent guide est fourni avec un logiciel régi par un contrat d’utilisateur final, ce guide, ainsi que le logiciel décrit, sont
fournis sous licence et peuvent être utilisés ou copiés uniquement selon les clauses et conditions de la licence. A moins d’une
autorisation expresse accordée par cette licence, aucune partie de ce guide ne peut être reproduite, stockée dans un système
d’interrogation ou transmise, sous quelque forme ou par quelque moyen que ce soit (électronique, mécanique, par enregistrement
ou autre) sans l’autorisation écrite préalable d’Adobe Systems Incorporated. Veuillez noter que le contenu du présent guide est
protégé par la loi sur les droits d’auteur, même s’il n’est pas distribué avec un logiciel régi par un contrat de licence utilisateur.
Les informations contenues dans ce guide sont fournies à titre purement informatif ; elles sont susceptibles d’être modifiées sans
préavis et ne doivent pas être interprétées comme étant un engagement de la part d’Adobe Systems Incorporated. Adobe Systems
Incorporated n’accepte aucune responsabilité quant aux erreurs ou inexactitudes pouvant être contenues dans le présent guide.
Veuillez noter que les illustrations et images existantes que vous souhaiterez éventuellement inclure dans votre projet sont
susceptibles d’être protégées par les lois sur les droits d’auteur. L’inclusion non autorisée de tels éléments dans vos nouveaux
travaux peut constituer une violation des droits du propriétaire. Veuillez vous assurer que vous obtenez toute autorisation
nécessaire auprès du détenteur du copyright.
Toute référence à des noms de sociétés dans les modèles types n’est utilisée qu’à titre d’exemple et ne fait référence à aucune
société réelle.
Adobe, le logo Adobe, Acrobat, Adobe Captivate, Adobe Connect, Adobe Press, Breeze, Flash, Flash Player, PDF et Shockwave
sont des marques commerciales ou des marques déposées d’Adobe Systems Incorporated aux Etats-Unis et/ou dans d’autres pays.
Java une marque commerciale ou une marque déposée de Sun Microsystems, Inc. aux Etats-Unis et dans d’autres pays. Toutes les
autres marques citées appartiennent à leurs propriétaires respectifs.
Adobe Systems Incorporated, 345 Park Avenue, San Jose, Californie 95110, Etats-Unis. A l’attention des utilisateurs du
Gouvernement des Etats-Unis. Ce logiciel et sa documentation sont des « articles commerciaux », conformément à la définition
de ce terme dans le document 48 C.F.R. §2.101, comprenant d’une part un « logiciel informatique commercial » et d’autre part
une « documentation de logiciel informatique commercial », conformément à la définition de ces termes dans le document 48
C.F.R. §12.212 ou 48 C.F.R. §227.7202, si approprié. Conformément aux documents 48 C.F.R. §12.212 ou 48 C.F.R.
§§227.7202-1 à 227.7202-4, si approprié, le logiciel informatique commercial et la documentation de logiciel informatique
commercial sont accordés sous licence aux utilisateurs du Gouvernement des Etats-Unis (a) uniquement en tant que produits
commerciaux et (b) uniquement avec les droits accordés à tous les autres utilisateurs selon les termes et conditions mentionnés
dans le présent contrat. Droits non publiés réservés dans le cadre des lois sur les droits d’auteur en vigueur aux Etats-Unis. Adobe
Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. A l’attention des utilisateurs du Gouvernement des
Etats-Unis, Adobe s’engage à respecter la législation relative à l’égalité des chances y compris, le cas échéant, les dispositions du
décret 11246, tel qu’amendé, à la section 402 de la loi sur l’assistance aux vétérans du Vietnam (Vietnam Era Veterans
Readjustment Assistance Act) de 1974 (38 USC 4212), et à la section 503 de la loi sur la réadaptation (Rehabilitation Act) de
1973, telle qu’amendée, et la réglementation des articles 41 CFR, alinéas 60-1 à 60-60, 60-250 et 60-741. La clause relative à
l’égalité des chances et les règlements énoncés dans la phrase précédente doivent être compris comme tels lorsqu’il y est fait
référence.
Les services Web d’Adobe® Connect™ Enterprise permettent à vos applications d’interagir avec
Adobe Connect Enterprise Server 6 ou avec Adobe Connect Enterprise Hosted 6.
Ce manuel décrit l’envoi des appels d’API XML à Connect Enterprise par les applications et
leur interprétation de la réponse XML. Il s’adresse aux développeurs désireux de concevoir des
applications personnalisées pour Connect Enterprise ou qui souhaitent intégrer ce dernier à
un autre système, par exemple à un système de gestion de la formation (LMS) ou à un service
d’annuaire LDAP.
Avant d’utiliser ce manuel, vous devez connaître les bases du langage XML et de l’utilisation
du protocole HTTP pour communiquer avec un serveur depuis une application cliente. Ce
manuel propose quelques exemples de code Java™, mais ne part pas du principe que vous
utilisez un langage ou un environnement spécifique.
Conseils et formation
Adobe propose un large éventail de ressources qui vous aideront à vous familiariser avec nos
produits et à les exploiter.
■ Centre des développeurs Adobe : Didacticiels, documents de référence, guides de script et
autres informations exhaustives.
■ Autres ressources : Formation, livres, forums d’utilisateurs, certificats de produits, etc.
■ Extras et téléchargements : Contenus et logiciels téléchargeables.
Centre des développeurs Adobe
Cette section communautaire du site Adobe.com fournit des informations aux utilisateurs
avancés, y compris aux développeurs de logiciels et de modules d’extension. Vous y trouverez
des didacticiels, des kits de développements logiciels (SDK), des guides de script et un
exemple de code, ainsi que des forums, des flux RSS, des séminaires en ligne et d’autres
ressources techniques.
7
Autres ressources
Sources d’informations et d’aide supplémentaires disponibles pour les produits Adobe.
■ Visitez la page d’accueil de l’assistance du site Web d’Adobe pour plus d’informations sur
les options de support technique gratuites et payantes. Les principaux problèmes sont
énumérés par produit dans les sites Web américain et japonais d’Adobe. Suivez le lien
Formation pour accéder aux livres Adobe Press, aux ressources de formation vidéo et en
ligne dirigées par un instructeur, aux programmes de certification logicielle d’Adobe, etc.
■ Visitez la section Communautés du site Web d’Adobe pour découvrir des forums, des
blogs et autres portails au travers desquels les utilisateurs partagent outils et informations,
posez des questions et découvrez comment les autres utilisateurs tirent le meilleur parti de
leurs logiciels. Les forums d’utilisateurs sont disponibles en anglais, français, espagnol,
allemand et japonais dans la page principale Support de votre site Web Adobe national.
Les blogs sont publiés dans un grand nombre de langues.
Extras et téléchargements
Pour les extensions et les contenus gratuits, visitez la communauté en ligne appelée Adobe
Studio® Exchange, où les utilisateurs téléchargent et échangent gratuitement des milliers
d’actions, des modules d’extension et d’autres contenus à exploiter avec les produits Adobe.
Pour visiter Adobe Studio Exchange, accédez au Pôle de création Adobe depuis la page
d’accueil du site Web d’Adobe.
Les téléchargements disponibles depuis le site Web d’Adobe comprennent des mises à jour
gratuites, des évaluations et d’autres logiciels très utiles. La section Plug-ins du magasin
d’Adobe permet d’accéder à des milliers de modules issus de développeurs tiers, qui vous
aideront à automatiser vos tâches, à personnaliser vos flux de travail, à créer des effets
professionnels spéciaux, etc.
Environnement de développement
Les services Web de Connect Enterprise vous permettent d’utiliser n’importe quel langage ou
plate-forme capable d’envoyer et de recevoir des requêtes XML via HTTP pour développer
des applications personnalisées. Par exemple, vous pouvez utiliser Java et la plate-forme J2EE,
C#.NET, PHP, un serveur de portail ou toute plate-forme de développement Web. La plupart
des applications personnalisées sont des portails ou des applications Web.
De façon générale, les types d’outils suivants se révèleront très utiles :
■ Une bibliothèque de code d’analyseur XML, si votre langage de programmation prend en
charge l’analyse XML.
8Avant de commencer
■ Une bibliothèque de code de gestion des cookies, qui vous aidera à gérer les cookies de
session renvoyés par Connect Enterprise.
■ Un outil permettant d’afficher les en-têtes des réponses et des requêtes HTTP dans un
navigateur. La plupart de ces outils sont disponibles sur Internet.
Nouveautés de ce manuel
La section du manuel du développeur présente un nouveau format de procédure qui décrit
les séquences d’appels nécessaires pour l’exécution de certaines tâches à l’aide de l’API XML.
Vous pouvez coder ces procédures dans votre application.
La référence d’API présente un nouveau format qui documente les paramètres et les URL de
requête, ainsi que les éléments et les attributs des réponses, avec des exemples de réponses et de
requêtes.
Un exemple d’application a été ajouté pour cette version. Cet exemple est une application
Java et JSP qui s’exécute sur tout serveur d’application ou Web compatible J2EE. Il décrit la
création, l’affichage et le chargement des réunions Adobe Acrobat® Connect Professional.
Appelé « firstapp », cet exemple d’application est disponible dans le fichier firstapp.zip du
dossier documentation/samples du CD du produit. Vous trouverez les instructions relatives à
l’installation et l’exécution de l’exemple d’application dans son fichier Lisez-moi.
Ressources supplémentaires
Vous trouverez sur Internet de nombreuses ressources très utiles fournissant des informations
sur Connect Enterprise et sur les services Web et XML.
Ressources de Connect Enterprise
Centre de ressources de Connect Enterprise Le centre de ressources, accessible depuis le
site Web d’Adobe, est régulièrement mis à jour et propose des didacticiels, des simulations, des
informations sur les pratiques conseillées et des liens menant à des procédures.
Centre des développeurs Connect Enterprise Le Centre des développeurs se révèlera très
utile pour les développeurs. Il est mis à jour régulièrement avec des didacticiels et des articles
sur la conception d’applications pour Connect Enterprise.
Centre de documentation Connect Enterprise Le Centre de documentation permet de
télécharger ou de consulter toute la documentation relatives aux produits Connect Enterprise.
Ressources supplémentaires9
Connect Enterprise Support Center Lorsque vous avez besoin d’une assistance technique,
le Support Center propose des informations à jour, y compris des notes techniques, des
présentations Connect Enterprise et des détails sur le programme de prise en charge. Vous
pouvez également consulter les Forums d’assistance pour des discussions entre utilisateurs sur
des problèmes techniques.
Centre de support sous licence Connect Enterprise Le Centre de support sous licence
propose de la documentation et d’autres ressources aux clients disposant d’une licence Adobe
Connect Enterprise Server 6.
Ressources XML et services Web
Le site Web Services Primer sur xml.com est une bonne introduction aux services Web.
Le didacticiel XML sur le site Web W3Schools (w3schools.com) peut vous aider à
commencer à utiliser XML.
Le didacticiel XPath, également sur le site Web W3Schools (w3schools.com), décrit XPath,
qui analyse un document XML pour que vous puissiez l’utiliser dans application.
Le didacticiel XSLT, un didacticiel tiers disponible sur le site Web W3Schools
(w3schools.com), vous enseigne les transformations XSL, qui permettent de convertir des
données XML en d’autres formats.
La spécification XSL Transformations (XSLT) disponible sur le site Web du W3C
(w3.org), de la commission de standards à l’origine de sa création, définit officiellement XSLT.
Représentation numérique de la date et de l’heure, disponible sur le site Web de
l’Organisation internationale de normalisation (iso.org), fournit des informations sur le
format de dates et d’heures standard selon la norme ISO 8601.
Formats de dates et d’heures disponibles sur le site Web du W3C (w3.org) est la définition
officielle du format de date et d’heure ISO 8601.
Autres ressources
Le Centre des développeurs Flash Player et le Centre des développeurs Flash Media Server,
tous deux accessibles depuis le Centre des développeurs Adobe, proposent des articles, des
exemples et des indications pertinentes pour développer des applications utilisant Adobe Flash
Player et Adobe Flash Media Server.
10Avant de commencer
Le didacticiel Concepts SCORM, disponible sur le site Web d’Eduworks Corporation
(eduworks.com), présente le modèle de référence des objets de contenus partageables
(SCORM, Shareable Content Object Reference Model) et décrive les Objets de contenus
partageables (SCO, Shareable Content Object) et les systèmes de gestion de la formation
(LMS, Learning Management System).
Une Introduction à la documentation LDAP, disponible sur le site Web de Kings Mountain
Systems (www.kingsmountain.com), fournit une présentation très utile du protocole LDAP
(Lightweight Directory Access Protocol). Ce site peut même fournir des matériaux de base ou
des liens pour les développeurs qui intègrent un annuaire LDAP à Connect Enterprise.
Microsoft SQL Server Connect Enterprise utilise une base de données Microsoft SQL
Server, dans laquelle vos applications personnalisées récupèrent et écrivent des données. Vous
trouverez des ressources très utiles dans le Centre des développeurs Microsoft SQL Server
(msdn.microsoft.com), y compris des références, une communauté d’utilisateurs, un support
technique et d’autres informations.
Conventions
Ce manuel utilise des conventions standard pour afficher le code que vous connaissez déjà.
Toutefois, la référence d’API est une définition formelle du contrat d’API passé entre
l’application appelante et le serveur. Il est donc nécessaire de décrire les définitions de syntaxe
des URL de requête.
Pour une meilleure lisibilité, nous avons placé les différentes sections d’une URL de requête
sur des lignes distinctes :
Lorsque vous entrez une URL de requête dans la barre d’adresse d’un navigateur ou que vous
la construisez dans une application, composez-la sur une seule ligne :
Les éléments de syntaxe en police de code bleue représentent les définitions que vous
construisez, avec un lien hypertexte vers la syntaxe de la définition.
Conventions11
12Avant de commencer
CHAPITRE 1
Architecture
Bienvenue dans les Services Web d’Adobe® Connect™ Enterprise, la couche de services Web
sur Adobe Connect Enterprise Server 6 et Adobe Connect Enterprise Hosted 6 et la suite
d’applications Connect Enterprise.
Les Services Web vous permettent de concevoir des portails ou des applications Web intégrant
les fonctionnalités Connect Enterprise et de collecter les informations de systèmes tiers, tels
que des portails et des systèmes de gestion des relations clients (CRM) et de planification des
ressources de l’entreprise (ERP).
Training
Presenter
Enterprise Server ou Enterprise Hosted
Les services Web de Connect Enterprise fournissent des fonctionnalités de réunion, de formation et
d’événement à vos applications via leur API XML.
Events
Meeting
APIs & SDKs
1
Vous pouvez par exemple disposer d’un système centralisé de gestion des utilisateurs, tel qu’un
annuaire LDAP, Microsoft Active Directory ou un autre système tiers, qui fait intégralement
partie de vos processus métier.
13
Les Services Web vous permettent d’écrire une application qui synchronise les utilisateurs
entre votre système et Connect Enterprise. L’application peut utiliser la plate-forme J2EE ou
toute autre technologie de votre choix pour récupérer la liste des utilisateurs dans l’annuaire, la
comparer à celle des utilisateurs de Connect Enterprise, puis effectuer les mises à jour
nécessaires au sein du référentiel d’utilisateurs de Connect Enterprise, par exemple en ajoutant
ou en supprimant des utilisateurs ou des groupes. Ceci n’est qu’un exemple d’application
personnalisée, vous en trouverez d’autres dans le Centre des développeurs Connect Enterprise.
Circulation des données
Le diagramme suivant présente le flux des données qui circulent entre des applications clientes
et Connect Enterprise. Les applications personnalisées que vous concevez utilisent les chemins
1 à 2 et A à B. Les applications Connect Enterprise (telles qu’Adobe® Acrobat® Connect™
Professional, Connect Training ou Connect Events) peuvent utiliser n’importe quel chemin.
Application cliente
Navigateur Web
Flash Player
1
HTTP:80
HTTPS:443
A
RTMPS:443
C
RTMP:1935
3
RTMPT:80
3a4a
Autorité de certification
2
B
D
4
Enterprise Connect
API
des
services
Web
Flash Media Server
Base de données SQL
Circulation des données entre des applications clientes et Connect Enterprise
Les données peuvent être cryptées avec SSL ou en clair.
14Chapitre 1: Architecture
Serveur Web/
Application
En clair Lorsque le flux des données n’est pas crypté, les connexions sont établies via les
protocoles HTTP et RTMP d’Adobe (Real Time Messaging Protocol) et suivent les chemins
décrits dans le tableau suivant.
1Le navigateur Web client demande une réunion Acrobat Connect Professional
ou une URL de contenu via le port HTTP:80 (les chemins de connexions
peuvent varier).
2Le serveur Web répond par un transfert de contenu ou fournit au navigateur
client les informations nécessaires pour accéder à Acrobat Connect
Professional.
3Adobe Flash
Server d’Adobe via RTMP:1935 et HTTP:80.
4Le serveur Flash Media répond et une connexion permanente est ouverte pour
diffuser le trafic de la réunion vers le navigateur.
3a
(alternative)
4a
(alternative)
Cryptée Si le flux de données est crypté, les connexions sont sécurisées via les protocoles
Dans certains cas, Flash Player requiert une connexion au serveur Flash
Media, mais ne peut obtenir qu’une connexion par tunnel via RTMPT:80.
Le serveur Flash Media répond et une connexion par tunnel est ouverte pour
diffuser le trafic de la réunion vers le navigateur.
® Player requiert une connexion à Macromedia® Flash Media
HTTPS and RTMPS (Real Time Messaging Protocol over SSL), comme suit.
ALe navigateur Web client requiert une réunion ou une URL de contenu
sécurisée via une connexion cryptée sur HTTPS:443 (les chemins de
connexions peuvent varier).
BLe serveur Web/d’application répond par un transfert de contenu crypté ou
fournit au client les informations nécessaires pour établir une connexion
cryptée à Acrobat Connect Professional.
CFlash Player requiert une connexion cryptée au serveur Flash Media via
RTMPS:443.
DLe serveur Flash Media répond et une connexion permanente est ouverte pour
diffuser le trafic de la réunion vers le navigateur.
Circulation des données15
Applications personnalisées
Les services Web Connect Enterprise fournissant une API XML, votre application doit
pouvoir communiquer avec Enterprise Server ou Enterprise Hosted à l’aide de XML sur
HTTP ou HTTPS. Votre application appelle l’API en créant une URL de requête et en lui
transmettant un ou plusieurs paramètres, soit sous forme de paires nom/valeur, soit sous
forme de document XML. Les services Web renvoient une réponse XML, dont vous pouvez
extraire les valeurs.
Les applications personnalisées récupèrent des métadonnées dans la base de données Connect
Enterprise. Les métadonnées comprennent les noms et les horaires des réunions et des cours,
les URL des salles de réunions et du contenu et les informations de rapport.
Dans le cas d’une application personnalisée récupérant les métadonnées dans la base de
données, les données circulent du navigateur Web client au serveur de l’application Web
cliente, à l’API XML, au serveur d’application Web Connect Enterprise, puis à la base de
données SQL, avant de revenir.
La circulation des données entre une application personnalisée et Connect Enterprise
fonctionne comme suit :
1. Un utilisateur accède à votre application personnalisée depuis un navigateur Web.
2. L’application appelle l’API XML via HTTP:80 ou HTTPS:443.
3. Le serveur d’application Web Connect Enterprise autorise l’application et ses utilisateurs,
récupère les métadonnées dans la base de données SQL et les renvoie.
4. Côté client, votre serveur d’application ou Web, un analyseur XML et des bibliothèques
logicielles gèrent la réponse et la renvoient à votre application.
5. L’utilisateur continue de travailler dans votre application personnalisée et clique sur l’URL
d’une réunion ou d’un contenu. A ce stade, l’utilisateur accède à une application Connect
Enterprise, telle qu’Acrobat Connect Professional, pour accéder à la salle d’une réunion, et
le flux de données typique entre une application Connect Enterprise et le serveur
commence.
16Chapitre 1: Architecture
Applications Connect Enterprise
Les applications Connect Enterprise appellent le serveur à l’aide de la même API XML de
services Web que celle que vous utilisez depuis une application personnalisée.
En général, le contenu est transmis via le port 80 HTTP ou le port 443 HTTPS. Il comprend
des diapositives, des pages HTTP, des fichiers Macromedia® Flash d’Adobe (SWF) et des
fichiers transférés par l’intermédiaire du module FileShare. Il s’agit là des numéros de port par
défaut que vous pouvez configurer (voir le Guide d’installation et de configuration de Connect Enterprise pour plus d’informations).
Les communications en diffusion continue et en temps réel provenant du serveur Flash Media
sont transmises via le port 1935 RTMP. Les communications en diffusion continue
comprennent du contenu audio et vidéo (Webcam et FLV), le partage de fichiers et les
conversations. L’état des réunions est également conservé via le port 1935 RTMP.
Composants de Connect Enterprise
Enterprise Server et Enterprise Hosted sont conçus avec deux composants de serveur et
chacun d’eux utilise une base de données SQL.
Le serveur d’application Web Il s’agit du « cerveau » de Connect Enterprise. Il contient et
exécute toute la logique métier nécessaire pour délivrer le contenu aux utilisateurs. Il gère le
contrôle d’accès, la sécurité, les quotas et les licences, de même que les fonctions de gestion,
telles que la mise en cluster, le basculement et la réplication.
Le serveur d’application Web gère également Connect Enterprise, l’application par
l’intermédiaire de laquelle vous affichez et gérez les utilisateurs et le contenu de votre
organisation, lorsque vous n’utilisez pas une application personnalisée ou un système tiers
intégré. Les métadonnées qui décrivent le contenu et les utilisateurs peuvent être stockées dans
une ou plusieurs bases de données SQL répliquées. Le serveur d’application Web est sans état,
ce qui signifie que sa mise à l’échelle est quasi linéaire.
Flash Media Server Il s’agit des « muscles » de Connect Enterprise Server. Flash Media
Server diffuse tout le contenu audio, vidéo et multimédia à l’aide du protocole RTMP.
Lorsqu’une réunion est enregistrée puis visualisée à nouveau, le son et la vidéo sont
synchronisés ou le contenu est converti et compacté pour le partage d’écran en temps réel. Ce
travail est effectué par Flash Media Server.
Flash Media Server joue également un rôle essentiel en réduisant la charge du serveur grâce à
la mise en cache des pages Web fréquemment accédées, des diffusions continues et des
données partagées.
Circulation des données17
La base de données SQL Connect Enterprise utilise la base de données Microsoft SQL
Server pour le stockage permanent des métadonnées applicatives et transactionnelles, dont les
utilisateurs, les groupes, le contenu et les informations de rapports. L’API XML récupère les
métadonnées stockées dans la base de données. La base de données peut être implémentée
avec le moteur de base de données intégré MSDE (Microsoft SQL Server Desktop Engine) ou
avec la version complète de Microsoft SQL Server 2000.
Conception de votre premier appel d’API
Les services Web de Connect Enterprise utilisent une infrastructure servlet pour gérer les
requêtes d’API XML. Dans le diagramme de circulation des données, l’infrastructure servlet
est représentée par le composant API. Le servlet API reçoit les requêtes XML des clients et
renvoie les réponses XML du serveur d’application Web et de la base de données.
Les requêtes à l’API XML sont mises en forme en tant qu’URL de requête HTTP gérées par le
servlet API. Une URL de requête présente un nom d’action et des paramètres dans des paires
nom/valeur, comme suit :
Si vous avez accès à un compte Enterprise Server ou Enterprise Hosted qui vous permet de
tester les appels d’API, procédez à quelques expériences. En réalité, Adobe recommande de
tester les appels d’API dans le navigateur pendant que vous vous familiarisez avec l’API et
écrivez des applications.
Avant de commencer, il est utile d’installer un outil qui vous permette d’afficher les en-têtes
des réponses et des requêtes HTTP dans votre navigateur.
Appel de common-info dans le navigateur
1. (Facultatif) Activez un outil qui vous permette d’afficher les en-têtes HTTP dans votre
navigateur.
2. Ouvrez un navigateur et naviguez jusqu’à votre page de connexion à Connect Enterprise.
3. Sans vous connecter, supprimez la partie de l’URL située après le nom de domaine et
ajoutez un appel à
https://example.com/api/xml?action=common-info
common-info :
La réponse de common-info vous donne des renseignements sur votre session avec le
serveur, en particulier le cookie identifiant votre session :
Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1;
.NET CLR 1.1.4322)
</user-agent>
</common>
</results>
Lorsque vous connectez un utilisateur depuis une application, vous devez renvoyer la
valeur du cookie au serveur pour identifier la session de l’utilisateur (voir Connexion
depuis une application).
Appelez principal-list dans un navigateur
Dès que vous connaissez la valeur du cookie BREEZESESSION par common-info, le navigateur
l’ajoute dans l’en-tête de votre prochaine requête.
1. Dans un navigateur Web, connectez-vous à Connect Enterprise. Modifiez l’URL du
navigateur pour appeler
https://example.com/api/xml?action=principal-list
2.
Vérifiez l’en-tête de la requête. Cette fois, il renvoie la valeur du cookie BREEZESESSION au
principal-list :
serveur :
GET /api/xml?action=principal-list HTTP/1.1
Accept: */*
Accept-Language: en-us
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET
La plupart des actions effectuées dans l’API vous permettent d’ajouter un filtre afin de ne
renvoyer que certains éléments de réponse ou d’ajouter un tri permettant d’afficher les
résultats dans un ordre spécifique.
Un filtre est un paramètre spécial qui commence par le mot-clé
modificateur facultatif, puis d’un nom de champ et d’une valeur. Voici des exemples de
filtres :
■ filter-name=jazz doe (qui renvoie les résultats comprenant le nom exact jazz doe)
■ filter-like-name=jazz (qui renvoie tous les résultats dont le nom contient le mot jazz)
■ filter-out-type=user (qui renvoie tous les résultats ne présentant pas de type user)
Ce ne sont là que quelques types de filtres, vous en trouverez d’autres à la section
definition
. Vérifiez une action dans la référence (Chapitre 6, Référence des actions) pour
savoir si la réponse peut être filtrée. En général, lorsqu’une action autorise les filtres, vous
pouvez les utiliser sur n’importe quel élément de réponse ou attribut.
Le tri est un autre paramètre spécial commençant par le mot-clé
suivi d’un nom de champ, puis de l’un des mots-clés
■ sort-name=asc (pour trier en ordre croissant par name)
■ sort-group-id=desc (pour trier en ordre décroissant par group-id)
asc ou desc ; par exemple :
Ce ne sont là que quelques exemples de tri. Vous pouvez tester les tris dans le navigateur ou
consultez la section
sort-definition pour en savoir plus.
filter, suivi d’un
filter-
sort (ou sort1 ou sort2),
20Chapitre 1: Architecture
Envoi d’un appel avec filtre et tri
1. Appelez de nouveau principal-list, en n’affichant que les groupes et en triant les noms
A ce stade, vous pouvez continuer à tester les appels dans le navigateur et observer leur
fonctionnement. C’est certainement le meilleur moyen, et le plus facile, de comprendre l’API
XML. Si vous avez besoin d’informations complémentaires, orientez-vous vers les ressources
suivantes :
■ La référence API au Chapitre 6, Référence des actions
■ Chapitre 2, Connexion et requêtes, pour plus d’informations sur la connexion des
utilisateurs depuis les applications
■ Chapitre 3, Notions de base, pour découvrir les trois concepts de base sous-jacents à l’API
■ Chapitre 4, Réunions, si vous souhaitez créer et gérer des réunions depuis une application
■ Chapitre 5, Formations, si vous concevez une application de formation
Conception de votre premier appel d’API21
22Chapitre 1: Architecture
CHAPITRE 2
Connexion et requêtes
Ce chapitre explique comment connecter un utilisateur depuis votre application, envoyer des
requêtes, gérer les réponses et déconnecter l’utilisateur.
Plusieurs méthodes permettent d’accomplir la plupart de ces tâches, selon votre
environnement de développement, la configuration du serveur et la conception de
l’application.
Connexion depuis une application
Toute application personnalisée, qui utilise les fonctionnalités des Services Web Adobe®
Connect™ Enterprise ou qui s’intègre à un système tiers, doit connecter l’utilisateur à Adobe
Connect Enterprise Server 6 ou à un compte Adobe Connect Enterprise Hosted 6. Dans sa
forme la plus simple, le processus de connexion appelle l’action
Toutefois, la technique de connexion varie, selon si vous utilisez la gestion des cookies, si vous
disposez d’un serveur sous licence ou d’un compte hébergé et si vous vous authentifiiez
directement auprès de Connect Enterprise ou auprès d’un autorité externe. Selon votre
environnement et la configuration du serveur, vous pouvez également combiner ces options.
Gestion des cookies Lorsqu’un utilisateur se connecte, Connect Enterprise renvoie un
cookie qui identifie sa session. Vous devez alors transmettre ce cookie au serveur lors de tous
les appels au serveur effectués pendant cette session. Ensuite, lorsque l’utilisateur se
déconnecte, le serveur fait expirer le cookie et vous devez l’invalider.
Dans votre environnement de développement, vous pouvez utiliser une bibliothèque de code
gérant les cookies à votre place. Le processus de connexion et la gestion de la session d’un
utilisateur diffèrent selon que vous utilisez une bibliothèque de gestion des cookies ou si vous
gérez vous-même la session de l’utilisateur.
login.
2
23
Serveur sous licence ou compte hébergéVotre organisation peut posséder un serveur
Connect Enterprise sous licence protégé derrière votre pare-feu ou un compte Enterprise
Hosted hébergé chez Adobe. Dans tous les cas, vous envoyez les requêtes XML via le protocole
HTTP ou HTTPS, mais les exigences de sécurité et le processus de connexion diffèrent. En
tant que client hébergé, vous pouvez utiliser certains paramètres avec l’action
login afin
d’éviter d’envoyer les identifiants utilisateur et les mots de passe via Internet.
Authentification directe ou externe Que vous soyez un client hébergé ou sous licence,
votre application peut s’authentifier directement auprès de Connect Enterprise, ou vous
pouvez authentifier les utilisateurs sur votre propre réseau, définir un identifiant dans l’en-tête
de requête HTTP, puis l’envoyer à Connect Enterprise. Le processus de connexion varie selon
si vous utilisez une authentification directe ou externe.
Connexion à Enterprise Server
La technique habituelle de connexion des utilisateurs à Enterprise Server emploie l’action
login, qui transmet l’identifiant de connexion et le mot de passe de l’utilisateur. Cette
technique fonctionne avec les requêtes HTTP
Vous devez également gérer le cookie
BREEZESESSION renvoyé par le serveur pour chaque
session d’utilisateur. Si vous utilisez une bibliothèque de gestion des cookies côté client, il est
bien plus facile de la laisser gérer les cookies à votre place que d’effectuer cette opération
vous-même. Si vous ne disposez pas d’une telle bibliothèque, appelez
paramètre
session car cette opération est plus facile et plus fiable que la définition de
valeurs d’en-tête HTTP.
REMARQUE
Si vous envoyez les mots de passe utilisateur à Enterprise Server, utilisez SSL de sorte
que les mots de passe soient cryptés pendant la transmission, même lorsque vous avez
installé Enterprise Server sous licence derrière votre propre pare-feu.
GET et POST.
login avec le
Connexion avec gestion des cookies
1. Appelez l’action login, en lui transmettant l’identifiant de connexion et le mot de passe de
3. Laissez votre bibliothèque de gestion des cookies gérer le cookie BREEZESESSION.
Votre bibliothèque côté client renvoie le cookie au serveur dans un en-tête de requête lors
des prochains appels pour le reste de la session utilisateur. Il n’est pas nécessaire de définir
explicitement le cookie dans l’en-tête. Lorsque l’utilisateur se déconnecte, le cookie expire.
Connexion à l’aide du paramètre session
1. Avant de connecter l’utilisateur, appelez common-info pour obtenir la valeur du cookie
BREEZESESSION :
http://example.com/api/xml?action=common-info
Récupérez la valeur du cookie dans la réponse :
2.
<cookie>breezxq66rt43poai3if8</cookie>
3.
Connectez l’utilisateur, en spécifiant la valeur du cookie :
5. Utilisez le paramètre session avec la même valeur de cookie dans les appels suivants de
l’utilisateur jusqu’à la fin de la session :
https://example.com/api/xml?action=principal-list
&session=breezxq66rt43poai3if8
6.
Lorsque l’utilisateur se déconnecte ou que la session se termine, ne réutilisez pas la valeur
du cookie.
Connexion à Enterprise Hosted
Pour vous connecter directement à un ou plusieurs comptes hébergés, utilisez toujours l’action
login, mais spécifiez un identifiant de compte ou un nom de domaine en plus de l’identifiant
de connexion et du mot de passe de l’utilisateur. Vous pouvez spécifier un nom de domaine
pour éviter d’envoyer un identifiant de compte via Internet.
Avec un compte hébergé, vous ne pouvez pas utiliser l’authentification unique ou externe.
Vous devez transmettre les informations d’authentification de l’utilisateur pour Enterprise
Hosted, pas les informations de connexion d’un réseau externe.
REMARQUE
Il est important d’activer SSL sur votre compte Enterprise Hosted car vous envoyez des
identifiants utilisateur, des mots de passe et des informations de compte à votre compte
hébergé chez Adobe via Internet.
Connexion depuis une application25
Connexion à Enterprise Hosted à l’aide d’un identifiant de compte
1. Avant de connecter l’utilisateur, appelez common-info avec le nom de domaine de votre
compte hébergé dans l’URL de la requête ou dans le paramètre
6. (Facultatif) Si vous préférez, vous pouvez appeler login avant common-info, extraire la
account-id et session :
valeur du cookie dans l’en-tête de la réponse, puis le gérer vous-même ou à l’aide d’une
bibliothèque de gestion des cookies. Pour plus d’informations, consultez la section
« Connexion avec gestion des cookies » ou « Connexion à l’aide du paramètre session ».
Connexion à Enterprise Hosted avec un nom de domaine
1. Avant de connecter l’utilisateur, appelez common-info avec le nom de domaine de votre
compte hébergé dans l’URL de la requête ou dans le paramètre
Le paramètre domain équivaut à account-id, mais en l’utilisant, vous évitez d’envoyer un
identifiant de compte via Internet, en particulier si vous utilisez une connexion non
cryptée.
6. Dans la réponse, recherchez le code d’état ok.
7. (Facultatif) Si vous préférez, vous pouvez appeler login avant common-info, extraire la
valeur du cookie dans l’en-tête de la réponse, puis le gérer vous-même ou à l’aide d’une
bibliothèque de code de gestion des cookies. Pour plus d’informations, consultez la section
« Connexion avec gestion des cookies » ou « Connexion à l’aide du paramètre session ».
Connexion à l’aide de l’authentification d’en-tête
HTTP
REMARQUE
Les instructions de cette section ne concernent qu’Enterprise Server.
Votre application peut utiliser un serveur central approuvé pour authentifier les utilisateurs
par l’intermédiaire d’une authentification unique et transmettre l’authentification (appelée ici
externe) de votre réseau à Enterprise Server, sans communiquer explicitement l’identifiant
utilisateur et le mot de passe Enterprise Server. (Pour des instructions détaillées sur la
définition et la configuration de l’authentification d’en-tête HTTP, consultez le Guide d’installation et de configuration d’Adobe Connect Enterprise).
Connexion depuis une application27
Avec l’authentification d’en-tête HTTP, l’utilisateur se connecte à votre serveur
d’authentification. Lorsque l’utilisateur est authentifié, vous ajoutez alors un en-tête de
requête HTTP qui l’identifie ou vous configurez un serveur proxy pour le faire. Le filtre
d’authentification sous Connect Enterprise (appelé
HeaderAuthenticationFilter)
convertit l’identifiant de votre utilisateur en identifiant de connexion Connect Enterprise et
authentifie l’utilisateur.
Serveur d’authentification
Serveur proxy
ExternesExternes avec en-tête
Filtre d’authentification
Enterprise Server
Connect Enterprise Server
Base de
données SQL
Les filtres d’authentification convertissent les informations d’authentification externes en
informations de connexion Enterprise Server.
L’authentification externe vient s’ajouter à l’authentification standard de Connect Enterprise.
Chaque utilisateur devant accéder à Enterprise Server doit disposer d’un identifiant de
connexion et d’un mot de passe Enterprise Server valides.
Lorsque vous envoyez une demande de connexion à Enterprise Server avec des informations
d’authentification externe :
■ Le filtre d’authentification intercepte la requête et recherche un utilisateur Enterprise
Server présentant un champ
ext-login correspondant à vos informations
d’authentification externe.
■ S’il existe une correspondance, le filtre transmet vos informations d’authentification
externe à Enterprise Server et le serveur connecte l’utilisateur.
■ S’il n’existe pas de correspondance, le filtre transmet la demande de connexion au serveur,
qui affiche sa page de connexion. L’utilisateur doit alors se connecter à Enterprise Server.
■ Si l’utilisateur réussit à se connecter, Enterprise Server actualise le champ ext-login du
profil de l’utilisateur avec les informations de l’authentification externe de votre requête.
Ensuite, chaque fois que vous envoyez une requête avec les informations d’authentification
externe de cet utilisateur, Enterprise Server trouve une correspondance dans le champ
et l’utilisateur n’a pas besoin de se connecter à Connect Enterprise.
login
■ Si l’utilisateur ne peut pas se connecter, il n’est pas autorisé à accéder aux applications, au
ext-
contenu ou aux réunions Enterprise Server.
28Chapitre 2: Connexion et requêtes
La procédure suivante décrit l’appel de login lorsque vous utilisez une authentification
d’en-tête HTTP.
Connexion à Enterprise Server à l’aide de l’authentification d’en-tête HTTP
1. Configurez vos serveurs réseau et Enterprise Server pour l’authentification d’en-tête HTTP
selon les instructions du Guide d’installation et de configuration de Connect Enterprise.
2. Dans [le répertoire de votre serveur]/appserv/conf/WEB-INF/web.xml, supprimez les balises
de commentaires qui entourent l’élément
HeaderAuthenticationFilter et ajoutez des balises de commentaires autour des autres
Ajoutez votre identifiant d’utilisateur authentifié dans l’en-tête de la requête HTTP.
Par défaut, utilisez le nom d’en-tête
x-user-id: joesmith
external-auth=use, mais pas les paramètres login ou password :
x-user-id :
Vous pouvez spécifier un nom d’en-tête différent en définissant la valeur de
HTTP_AUTH_HEADER dans le fichier custom.ini. Vous pouvez également configurer un
serveur proxy pour qu’il définisse la valeur de l’en-tête HTTP. Pour plus d’informations
dans les deux cas, consultez le Guide d’installation et de configuration de Connect Enterprise.
7. Dans la réponse, recherchez le code d’état ok.
8. Gérez la valeur de cookie BREEZESESSION renvoyée dans l’en-tête de la réponse. Pour ce
faire, vous avez deux possibilités.
Si vous utilisez une bibliothèque cliente qui gère les cookies Laissez votre
bibliothèque extraire la valeur du cookie, la stocker et la renvoyer au serveur lors des
prochaines requêtes de l’utilisateur.
30Chapitre 2: Connexion et requêtes
Loading...
+ 268 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.