Documente Academic
Documente Profesional
Documente Cultură
Avertissement
Bien que des efforts aient été faits pour vérifier l'exhaustivité et l'exactitude des informations contenues
dans cette documentation, ce document est fourni « tel quel ». Pour obtenir des informations plus
précises sur l'intercompatibilité, les limites du produit, la politique logicielle et la liste des fonction,
veuillez vous référer aux documents précis publiés sur le site web Business Partner.
Dans l'intérêt du développement continu des produits, ALE International se réserve le droit d'apporter
des améliorations à ce document et aux produits qu'il décrit, à tout moment et sans préavis ni
obligation.
Le marquage CE indique que ce produit est conforme aux Directives du Conseil ssuivantes :
• 2014/53/EU pour équipement radio
• 2014/35/EU et 2014/30/EU pour les équipements autres que radio (y compris les équipements de
terminaux de télécommunication câblés)
• 2014/34/EU pour équipement ATEX
• 2011/65/UE (RoHS)
• 2012/19/EU (WEEE)
Sommaire
API de gestion des utilisateurs
Chapitre 1
Documents de référence
Chapitre 2
Présentation
2.1 Introduction.......................................................................................................................................5
2.2 Sources API fournies dans le serveur OmniVista 8770 ........................6
2.3 Utilisation de ce document................................................................................................ 6
Chapitre 3
Description détaillée
1 Documents de référence
Le tableau ci-dessous recense les documents pouvant être associés au présent document :
Dans le présent document, les références croisées sont identifiées par le numéro figurant dans la
première colonne dans le tableau ci-dessus.
Les numéros de référence sont indiqués dans la dernière colonne, xx correspondant au code de
langue du document et yy à l'édition incrémentée du document.
2 Présentation
2.1 Introduction
L'OmniVista 8770 offre une solution API (Application Programming Interface) permettant de configurer
des utilisateurs et des équipements à partir d'applications tierces. Cette solution API est basée sur le
protocole SOAP (Simple Object Access Protocol).
L'API permet de créer, consulter, modifier ou supprimer des utilisateurs à partir d'applications tierces.
Elle concerne les utilisateurs suivants :
• Utilisateurs de base de l'annuaire de l'entreprise. Ils ne sont pas associés à un équipement et ne
sont rattachés à aucun serveur de communication (OpenTouch ou OmniPCX Enterprise).
• Utilisateurs OXE associés à un équipement déclaré dans l'OmniPCX Enterprise et n'ayant pas
accès aux applications OpenTouch.
• Utilisateurs OXE (également appelés Connection users) associés à un équipement déclaré dans
l'OmniPCX Enterprise et ayant accès aux applications OpenTouch ou aux boîtes vocales de
l'OTMC.
• Utilisateurs OT (également appelés Conversation users) associés à un équipement déclaré dans
l'OpenTouch et ayant accès ou non aux applications OpenTouch.
L'API permet également de créer des équipements et d'associer/dissocier des équipements à/d'un
utilisateur. Cela s'applique aux équipements SIP pouvant être déployés sans leur adresse MAC (auto-
assignation), applications et postes secondaires (configuration multi-équipements). Pour voir la liste
des équipements avec auto-assignation et applications, consultez le document [8].
Ces fonctions sont similaires à celles de l'application Users de l'OmniVista 8770. L'API ne permet pas
de configurer :
• les méta profils
• les équipements qui ne sont pas associés à un utilisateur
• les utilisateurs et les équipements via le provisionnement en masse
L'utilisation de l'API nécessite une licence dédiée dans l'OmniVista 8770 (appelée OpenAPI). Le statut
de la licence peut être vérifié dans le menu d'aide d'un client OmniVista 8770 (chemin d'accès : Help >
About).
Requêtes HTTPS
Composant API
Application
Users
Utilisateur API Méta
profils
Serveur
Profils
OXE
OmniPCX Enterprise
Modèles
OT
OpenTouch
Figure 2.1 : Présentation d'une solution API pour la configuration d'utilisateurs et d'équipements depuis
une application tierce (utilisateur API)
Les données échangées avec des applications tierces sont cryptées en HTTPS. Chaque requête
HTTPS est authentifiée à l'aide d'un compte administrateur OmniVista 8770 dédié (identifiant et mot de
passe) créé lors de l'installation du serveur OmniVista 8770.
Le nombre de transactions réalisées en parallèle depuis différentes applications tierces via cette API
est limité par un paramètre de configuration de l'application LDAP (chemin d'accès dans l'application
Administration de l'OmniVista 8770 : nmc > Application Configuration > Applications Settings >
OpenApiManagement > OpenApi). Le serveur maître doit être redémarré pour appliquer la
modification. Par défaut, le nombre maximum de transactions parallèles est de 5. Lorsque la limite est
dépassée, la transaction qui suit est rejetée et le message d'erreur ci-après s'affiche : Too many
parallel requests.
3 Description détaillée
Schéma
Méta profil
Modèle
Modèle
d'équipement
Légende :
Le tableau ci-dessous présente la hiérarchie des objets de données (également appelés ressources)
renvoyés par l'API :
Hiérarchie Ressource
/ov8770/schema Schéma
/ov8770/data/users Utilisateurs
3.1.3.2 Usager
Les utilisateurs peuvent être des utilisateurs OT (également appelés Conversation users), des
utilisateurs OXE ou des utilisateurs OXE ayant accès à des applications OpenTouch ou OTMC
(également appelés Connection users). Ils sont déclarés dans l'OmniVista 8770 et dans les nœuds
correspondants (OmniPCX Enterprise, OpenTouch et/ou OTMC) auxquels ils sont associés.
Lors de la création d'un utilisateur à l'aide d'un méta profil, un ou plusieurs équipements peuvent
également être créés et associés à cet utilisateur.
La manière dont un équipement est associé à un utilisateur lors de la création d'un utilisateur diffère
selon le type d'utilisateur : Connection ou Conversation.
Pour Connection users, le choix d'associer ou non un équipement de type donné est effectué en
assignant un profil d'équipement (pour softphone ou mobile) ou un type de poste (pour un poste DECT
secondaire) dans la demande de création d'un utilisateur. Les numéros d'annuaire des équipements
associés sont automatiquement calculés à partir des paramètres définis dans le méta profil sélectionné
ou expressément indiqués dans la demande de création d'un utilisateur.
Pour Conversation users, le méta profil sélectionné détermine expressément le ou les équipements
(depuis les types poste de bureau ou softphone uniquement) à associer à l'utilisateur.
Les paramètres utilisateurs renvoyés par l'API sont listés dans le tableau ci-dessous. Les autres
paramètres sont inclus dans des méta profils et/ou conservent leurs valeurs par défaut.
Accès WRITEONLY : Concerne les attributs tels que les mots de passe. L'opération Get ne renvoie
aucune valeur pour cet attribut ou renvoie une valeur de type ********.
Accès WCREATE_RUPDATE : La valeur de l'attribut correspondant ne peut être spécifiée que lors de
l'opération Create (non applicable à l'opération Update).
Note :
Lorsqu'un équipement est créé pour un utilisateur, son numéro d'annuaire est attribué comme suit :
1. Utilisation de la valeur directoryNumber indiquée dans les données d'entrée de l'équipement si cette valeur est
définie. Dans le cas contraire :
2. Récupération d'un DirectoryNumber dans la plage deviceFreeNumberRange si cette plage est définie. Dans le
cas contraire :
3. Récupération d'un DirectoryNumber dans la plage user.metaprofile.deviceFreeNumberRange si cette plage est
définie. Dans le cas contraire :
4. Erreur. Impossible d'obtenir un directoryNumber.
Les méta profils peuvent également contenir des profils OmniPCX Enterprise et des modèles
OpenTouch créés sur leurs nœuds respectifs et récupérés par l'OmniVista 8770 après une
synchronisation.
Les méta profils ne peuvent pas être configurés par le biais d'une API. Ils doivent être créés et
configurés à l'aide de l'application Users de l'OmniVista 8770.
Contrairement aux méta profils utilisés pour les Conversation users, les méta profils pour les
Connection users ne déterminent pas les types d'équipement qui seront associés à l'utilisateur lors de
la création d'un utilisateur, mais définissent uniquement les règles de calcul automatique des numéros
d'annuaire, selon le type d'équipement. La sélection des équipements à associer à un utilisateur en
cours de création est effectuée en assignant un profil d'équipement dans la demande de création d'un
utilisateur.
L'API ne peut renvoyer qu'un sous-ensemble minimal de paramètres de méta profil via l'opération Get
(voir : Méthode Get à la page 22). Les paramètres de méta profil renvoyés par l'API sont les suivants :
3.2.2 En-tête
La zone d'en-tête de chaque transaction doit inclure les valeurs/attributs suivants :
• Nom de connexion (compte administrateur créé au préalable dans l'OmniVista 8770)
• Mot de passe (mot de passe associé au nom de connexion de l'administrateur, défini au préalable
dans l'OmniVista 8770)
• Identification client (texte ASCII enregistré dans l'OmniVista 8770). Cet attribut peut également être
utilisé pour effectuer des recherches à partir de l'API. Si aucune valeur n'est spécifiée, la valeur est
définie par défaut sur OpenAPI.
• Remarques client (optionnel) : il s'agit d'un texte libre permettant aux utilisateurs finaux d'identifier
leurs opérations. La valeur n'est pas enregistrée dans l'OmniVista 8770, mais apparaît dans les
entrées du fichier journal.
Get (hierarchy, filter) Renvoie tous les ID d'objet spé- Seuls les ID d'objet sont renvoyés
cifiés dans la hiérarchie et cor- lors de l'opération de recherche.
respondant aux critères de fil- Le critère de recherche doit être
trage. indiqué dans la syntaxe LDAP
standard.
Note :
• Pour toutes les opérations Get susceptibles de renvoyer des items multiples, le nombre maximal de résultats
de recherche est prédéfini dans l'OmniVista 8770 mais peut être modifié.
• Si la recherche n'aboutit qu'à un seul résultat, les données renvoyées sont les données XML de cet objet.
• Si la recherche aboutit à plusieurs résultats, les données renvoyées sont les données XML au format
listResult.
Le tableau ci-dessous répertorie les chaînes de hiérarchie et les filtres disponibles pouvant être
appliqués à la méthode Get. Dans le tableau, une cellule vide indique qu'aucun filtre n'est disponible
pour cette méthode Get.
Le tableau ci-dessous répertorie les chaînes de hiérarchie disponibles pouvant être appliquées à la
méthode Create.
Hiérarchie Résultat
Create(/ov8770/data/users, data Crée un utilisateur avec les valeurs spécifiées dans les
in XML format) données d'entrée au format XML (peuvent inclure des
données sur l'équipement et la boîte vocale). L'utilisa-
teur est créé dans l'OmniVista 8770 et dans les nœuds
correspondants (OmniPCX Enterprise, OpenTouch
et/ou OTMC) auxquels il est associé. Les équipements
sont créés et associés à l'utilisateur, et des fichiers de
configuration sont créés pour la mise en service de
l'équipement.
Note :
• L'opération Create est prise en charge uniquement pour les objets User ou les objets Device associés aux
utilisateurs.
• L'opération Create ne prend pas en charge la réussite partielle comme le ferait le client OmniVista 8770.
• Seuls des équipements SIP avec une auto-assignation ou des applications peuvent être créés. Pour voir la
liste des équipements auto-provisionnés et applications, consultez le document [8].
Le tableau ci-dessous répertorie les chaînes de hiérarchie disponibles pouvant être appliquées à la
méthode Update.
Hiérarchie Résultat
Note :
• L'opération Update est uniquement possible pour les objets User et les extensions SIP secondaires.
• L'opération Update ne prend pas en charge la réussite partielle comme le ferait le client OmniVista 8770.
• Les données au format XML utilisées pour la mise à jour ne doivent contenir que les attributs et les valeurs à
mettre à jour. Concernant l'attribut MetaProfile, si les données d'entrée XML ne contiennent aucune
valeur pour l'attribut metaProfile, l'utilisateur est converti en utilisateur de base de l'annuaire d'entreprise.
Si les données d'entrée XML contiennent un attribut (autre que l'attribut metaprofile) sans valeur, la valeur
de l'attribut sera supprimée.
Le tableau ci-dessous répertorie les chaînes de hiérarchie disponibles pouvant être appliquées à la
méthode Delete.
Hiérarchie Résultat