Présentation de la conception de l'API SOAP

L'API SOAP de Unica Campaign Services est une façade qui offre une vue client d'une instance d'application Unica Campaign. Seul un sous-ensemble des fonctions de Unica Campaign est exposé, mais il suffit pour gérer certains aspects de la fonctionnalité Unica Campaign.

Fonctions et diagramme

L'API est utilisée simultanément avec des utilisateurs Web Unica Campaign et d'autres threads de l'API.

En règle générale, l'API prend en charge les types d'opérations suivants sur les campagnes, les offres et les composants de population ciblée :

  • Création de composant
  • Reconnaissance de composant
  • Suppression de composant
  • Attribut de composant et création, inspection, et modification des métadonnées d'attribut
  • Extraction des résultats de l'exécution du diagramme

Le diagramme suivant présente un exemple de déploiement de CampaignServices 3.0.



authentification des utilisateurs

L'authentification consiste à établir l'identité d'un utilisateur. L'authentification des utilisateurs incombe à l'application client.

Autorisation de l'utilisateur

L'autorisation concerne les droits dont un utilisateur authentifié dispose concernant les composants et les opérations exposés par l'API.

Il est possible qu'un utilisateur soit correctement authentifié mais ne dispose pas de droits suffisants pour effectuer certaines opérations, telles que le changement des informations récapitulatives d'une campagne. Dans ce cas, la méthode d'API émet AuthorizationException.

Environnement local

Les requêtes API fournissent un paramètre requestedLocale facultatif qui définit les paramètres régionaux à utiliser pour effectuer cette requête particulière. S'il n'est pas défini, l'API utilise par défaut les paramètres régionaux préférés de l'utilisateur . L'algorithme de mise en correspondance optimale Java™ habituel est utilisé pour renvoyer des messages et tout autre texte localisé selon les paramètres régionaux demandés.

Ce paramètre fait partie de la classe de type java.util.Locale.

Remarque : Certains textes spécifiés par l'utilisateur, tels que les descriptions de campagne, se trouvent dans les paramètres régionaux de l'utilisateur qui a spécifié le texte. Unica Campaign n'essaie pas de localiser ces données. Seuls les messages d'information, d'avertissement et d'erreur sont localisés par l'API.

Gestion d'état

L'API CampaignServices est sans état, ce qui signifie qu'aucune information par client n'est enregistrée par l'API au travers des appels.

Bien entendu, des appels API spécifiques peuvent changer l'état des instances de composant sous-jacentes gérées par Unica Campaign, et ces changements d'état peuvent être conservés dans la base de données.