Créer un projet API d'écriture multi-membres

À noter

Toute création de projet en écriture mutli-membres est soumise à la validation de la coordination globale du réseau.

Les développements s'effectuent sur une plateforme indépendante et non sur la plateforme de production. Pour plus de détails, voir les pré-requis ci-dessous.

Pré-requis côté Prestataire technique 

• Etre membre du réseau et donc disposer d'un compte sur la plateforme. Si vous n'avez pas de compte de membre, merci de suivre les instructions présentées sur cette page pour en faire la demande.
• La création de projet API d'écriture multi-membres nécessite les droits suivants dans la plateforme :
  • Gestionnaire d'objets (avec activation des droits sur les types objets nécessaires)
  • Prestataire d'API d'écriture,
  • Gestionnaire API d'écriture,
  • Configuration technique.

Le membre qui créé un projet multi-membres doit donc disposer de tous les droits utiles à un contributeur généraliste à l'exception du périmètre géographique. C'est l'abonnement des membres qui étendra le périmètre géographique du projet à leur zone de compétence.

Si vous constatez des manques dans vos permissions, n'hésitez-pas à vous rapprocher de la coordination globale du réseau en utilisant le formulaire de demande d'aide de ce site ou en utilisant le mail suivant : hotline.dev@apidae-tourisme.com

• Avoir un compte sur la plateforme de recette afin de réaliser vos développements. Si ce n'est pas le cas, adressez votre demande à la coordination globale du réseau en utilisant le formulaire de demande d'aide de ce site ou en utilisant le mail suivant : hotline.dev@apidae-tourisme.com

Pré-requis côté Office de Tourisme pour l'utilisation du projet

• Disposer de la permission de "Gestionnaire API d'écriture".
  Si vous ne disposez pas de cette permission nécessaire pour créer votre projet API d'écriture, contactez votre animateur départemental en utilisant le formulaire de demande d'aide de ce site. 
• Etre abonné au projet multi-membres : Gérer sa participation à un projet mutli-membres

Marche à suivre

Rappel : Dans le cas d'un projet d'écriture en multi-membres, c'est le fournisseur de services qui créé le projet d'écriture. C'est lui qui décide ce qu'il aura le droit de faire et sur quels types d'objets. C'est aussi lui qui gère les autorisations de ses différents serveurs.

Le membre client devra juste s'abonner ou non à un projet numérique après avoir vérifié que les réglages faits par le fournisseur de service lui conviennent. Au moment où un membre s'abonne à un projet mutli-membres, il donne simplement les droits de collaboration au fournisseur de service sur les communes de son périmètre géographique.

Pour créer un projet API d’écriture multi-membres, cliquez sur le module Diffuser / Mes projets / Mes projets.
A partir de l’écran Mes projets, cliquez sur le bouton Créer situé en haut à droite de l’écran


Dans la pop-up choisissez Multi-membres (API d'écriture).

Renseignez le formulaire de création du projet :

1. Nom : renseignez le nom de votre projet selon la charte de nommage suivante : type projet – nom du projet (ex : API Ecriture Wannago – OT X)
2. Type : spécifiez le type de votre projet en fonction de son objectif :
   • Intégration ponctuelle de données
   • Synchronisation en écriture avec une plateforme tiers
   • Formulaires de mises à jour
   • Autre type de projet
3. Propriétaire : Champ rempli par défaut
4. Spécifiez l’état du projet :
   • En développement : Ce projet alimente un projet numérique en phase de construction
   • En production : Ce projet alimente un projet numérique opérationnel
5. Décrivez précisément votre projet.
   Cette étape à un double objectif : valoriser votre travail et permettre aux autres membres du réseau des projets similaires aux leurs de pouvoir échanger sur les bonnes pratiques. En quelques mots, indiquez ici les objectifs de votre projet, la ou les cibles de clientèles, les principaux services apportés aux utilisateurs, les types d’objets Apidae utilisés, la contribution de votre projet à votre stratégie globale ou encore tout autre élément permettant au lecteur d’avoir une idée du positionnement de votre service.
6. Enregistrez la création de votre projet 

Votre projet est bien créé. Un message vous informe qu’il doit maintenant être validé par un référent Apidae.

Configuration technique

Sur l'onglet configuration de votre projet, cliquez sur le bouton de modification 

1. Sélectionnez les actions nécessaires au bon fonctionnement du projet : création, modification, demande de suppression.
2. Ajoutez ensuite les différents types objets sur lesquels le projet sera autorisé à intervenir.
3. Choisissez l'auteur des écritures par défaut. Lorsqu'un projet n'utilise pas l'identification de l'utilisateur par SSO, il utilisera le nom par défaut.
4. Validation directe : si la validation directe est autorisée, les données entrant via les API seront intégrées directement si elles ne comprennent pas d'erreurs de saisie.
   A noter que la suppression directe n'est jamais possible.
   Si la validation directe n'est pas cochée, chaque envoi de donnée effectué par les API devra faire l'objet d'une validation du membre destinataire.

Créer un client OAuth

À noter : la configuration OAuth est à effectuer par le membre Apidae et non par le fournisseur de services.

Pour finir, votre fournisseur de services aura ensuite besoin de connecter ses serveurs aux API. Pour ce faire, il devra utiliser un client OAuth.
Pour lui permettre de connecter ses serveurs sur les API, il vous faudra créer un client OAuth pour chacun de ses serveurs.

Dans l'onglet Informations générales du projet, cliquez sur le bouton Plus du bloc Liste des clients OAuth

Pour chaque client, il faudra renseigner l'e-mail de votre prestataire et une description du serveur concerné. Les URL de redirection autorisées peuvent rester vides dans le cadre des projets en écriture.

La gestion des abonnés

Les clients des projets mutli-membres viennent s'abonner eux-mêmes aux projets après avoir vérifié que la configuration du projet leur convient.

Les membres abonnés au projet sont visibles sur l'onglet "Abonnés" du projet. Il vous est possible à tout moment de dissocier un membre en cliquant sur la petite poubelle rouge en bout de ligne.