> API OUT

Cette documentation a pour objectif de vous donner un aperçu des possibilités offertes par les API d’export de données de la suite 6Tzen. Elle détaille les méthodes les plus utiles ainsi que l’ensemble des méthodes disponibles (avec leurs paramètres d’entrée et de sortie).

Ces API sont disponibles avec 2 niveaux de sécurité :

  • niveau de sécurité simple avec des appels simplement authentifiés.
  • niveau de sécurité plus élévé avec des appels signés (utilisation d’un fichier jks).

Pour pourvoir tester ces API vous devez disposer d’un espace de test personnalisé (bac à sable). Veillez contacter les équipes 6Tzen pour disposer d’un tel espace. Elles vous fourniront alors toutes les informations utiles (WDSL, login, mot de passe, etc.).

Télécharger la documentation qui présente étape par étape, une connexion à ces API avec l’outil SOAP UI (dans le cas d’appels simplement authentifiés).

 

Documentation complète

technical-support    

     La documentation complète est disponible ici.


Architecture générale

Accéder aux informations des dossiers

noteList permet de lister les dossiers selon un certain nombre de critères (date de mise à jour, nature, propriétaire, etc.).

Ensuite il faut utiliser les id de dossier renvoyés pour interroger noteDetail qui permet d’obtenir les informations principales du dossier (titre, statut, propriétaire, priorité, canal de transmission, etc.) à partir de son id.

Les données sont renvoyées sous forme de type et d’id. Il faut ensuite utiliser les méthodes contentDetail* pour récupérer les contenus de ces données de dossier selon leur type (utiliser contentDetailEmail pour une donnée de type « email », contentDetailAttachment pour une donnée de type « pièce jointe », etc. )

A noter qu’à partir d’un id de dossier, on peut aussi utiliser la méthode noteReport qui renvoie toutes les informations du dossier à partir de son id et d’un ou plusieurs champs de fusion.

 

Accéder aux informations des partenaires

Il en va de même pour les partenaires (tiers, usagers, etc.).

partnerList permet de lister les partenaires selon un certain nombre de critères (date de mise à jour, type).

Ensuite il faut utiliser les id de partenaires renvoyés pour interroger partnerDetail et récupérer les informations de ce partenaire. La liste des données concernant ce partenaire sont renvoyées sous forme d’id et de type.

Il faut ensuite utiliser les méthodes partnerDataContentDetail* pour récupérer les contenus des données du partenaire selon leur type (utiliser partnerDataContentDetailMail pour une donnée de type « email », partnerDataContentDetailTelephone pour une donnée de type « téléphone », etc. )

Les autres méthodes

Enfin il reste deux groupes de méthodes :

    • La liste des dossiers et partenaires supprimés sur une période donnée : deletedNoteList, deletedPartnerList

 

    • Les listes des données de référence de l’application :

> noteNatureList : les natures

> noteStatusList : les statuts

> orgNodeList : les services

> partnerTypeList : les types de partenaires

> partnerSubTypeList : les sous-types de partenaires

> themeList : les thèmes

> transmissionChannelList : les canaux de transmissions

 

Documentation complète

La documentation complète est disponible ici.