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.

Pré-requis

La création de projet API d'écriture est soumise l'attribution de permissions au niveau du membre et de l'utilisateur. Votre prestataire technique doit également avoir des permissions spécifiques.
Vous pouvez vérifier sur la fiche détaillée de votre membre si vous avez la permission Gestionnaire API d’écriture 

Si vous ou votre prestataire technique ne disposez pas des permissions nécessaires pour créer votre projet API d'écriture, contactez info@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) ou Multi-membres (API d'écriture) si votre projet à vocation à être utilisé par plusieurs membres.

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: Autre type de projet
3. Propriétaire : Champ rempli par défaut
4. Spécifiez l’état du projet :
   1. En développement : Ce projet alimente un projet numérique en phase de construction
   2. 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. [Tant que votre projet n’est pas validé, l’export ne s’effectue pas (pas de calcul des sélections, export non généré) et votre prestataire technique ne peut donc pas récupérer les flux.]

Sur l'onglet "configuration", sélectionnez les actions nécessaires au bon fonctionnement du projet : création, modification, demande de suppression.

Ajoutez ensuite les différents types objets sur lesquels le projet sera autorisé à intervenir.
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.

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.

Complétez votre projet en associant votre prestataire technique et prévenez-le afin qu'il puisse l'utiliser.