Documentation technique

Projet API

Retrouvez tous les éléments pour configurer un projet exploitant les API.

Configuration d’un projet API

apiexports

Pour configurer un projet API, il faut cocher la case API pour les technologies utilisées et indiquer une fréquence de génération pour les sélections.

Si vous choisissez d’inclure les objets masqués, il vous est nécessaire de prendre en compte le champ state des objets de manière à limiter les affichages publics aux seuls objets ‘PUBLISHED’. Il est recommandé de laisser cette case décochée.

Les paramètres suivants sont sans effet vis à vis de l’exploitation des API : format (seul le JSON est disponible), version (le format est déterminé par les urls de service utilisées), grouper les objets exportés (exports seulement), exporter les dates d’ouverture (exports seulement), url de notification (exports seulement)
Même s’il n’est pas restrictif, merci de renseigner autant que possible le champ version de manière cohérente avec votre utilisation des API.

API Multi-membres

Dans le cadre de l’utilisation des API en écriture, certains prestataires souhaitent pouvoir modifier les objets de différents membres. Précédemment, l’unique option permettant d’atteindre ce but consistait à créer un projet par membre, et ainsi modifier les objets au sein de chacun de ces projets.

Ce mode de fonctionnement avait pour inconvénient majeur de faire maintenir par le prestataire une multitude de projets.
Afin de remédier à cet inconvénient, l’ajout des projets multi-membres vise à associer plusieurs membres à un même projet, afin que le prestataire exploitant ce projet puisse mettre à jour les objets de ces membres.

Ce type de projet est disponible à la création, et se configure de la même manière qu’un projet en écriture.multimembres multimembres

Par ailleurs, l’écriture est associée à un utilisateur unique défini au niveau du membre, contribuant ainsi à fausser l’attribution de la fiche. L’utilisation de l’API en écriture pouvant être conjuguée à l’utilisation de l’API SSO. Ce fonctionnement contribue à générer des situations de blocage lorsqu’un brouillon est généré.

N’importe quel utilisateur peut consulter la fiche d’un projet multi-membre.

Pour pouvoir devenir membre collaborateur du projet multi-membre, il est nécessaire de se rendre sur la page du projet en question, et de s’y abonner. Ainsi, le membre de l’utilisateur s’abonnant est ajouté à la liste des collaborateurs du projet. Un onglet « S’abonner » est également présent dans « Diffuser »/ »Projets ».