Créer un projet API d'écriture

Merci à Françoise Matkovic (Animatrice Apidae - Aintourisme) pour la rédaction de ce tuto

A noter

Toute création de projet est soumise à validation. La validation des projets est effectuée soit par votre animateur départemental Apidae, soit par la coordination globale du réseau.

Les développements s'effectuent sur une plateforme indépendante et non sur la plateforme de production. 

Pré-requis côté Office de Tourisme

La création de projet API d'écriture est soumise l'attribution de permissions au niveau du membre et de l'utilisateur. Il est nécessaire d'avoir la permission de Gestionnaire API d’écriture. Vous pouvez vérifier sur la fiche détaillée de votre membre si vous avez bien cette permission. 

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. 

Pré-requis côté Prestataire technique

• Etre membre du réseau et donc disposer d'un compte sur la plateforme. Si votre prestataire technique n'a pas de compte de membre, merci de lui faire suivre les instructions présentées sur cette page pour qu'il puisse en faire la demande.
• Votre prestataire technique doit également avoir la permission de "Prestataire d'API d'écriture". Si vous constatez que ce n'est pas le cas, contactez votre animateur départemental en utilisant le formulaire de demande d'aide de ce site. 
• Votre prestataire devra également disposer d'un compte sur la plateforme de recette afin de réaliser les développements. Si ce n'est pas le cas, il devra en faire la demande auprès 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
• N'hésitez-pas à communiquer à votre prestataire technique le lien vers la documentation développeurs https://dev.apidae-tourisme.com/ ainsi que le mail de contact de la hotline technique : hotline.dev@apidae-tourisme.com

Marche à suivre

Pour créer un projet API d’écriture, 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 Ecriture (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 ou annulez 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.

Associer votre prestataire technique

Complétez votre projet en associant votre prestataire technique dans l'onglet Informations générales et prévenez-le afin qu'il puisse l'utiliser.

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.