Pré-requis Apidae¶
La synchronisation entre Open Edit et Apidae s'effectue à travers les projets.
Il est nécessaire de créer un projet de diffusion qui permettra la synchronisation des offres entre les outils au travers de vos sélections.
En complément, vous devrez soit :
-
vous abonner au projet multi-membres Open Edit - Écriture pour permettre à Open Edit d'écrire sur vos fiches Apidae
-
créer un projet d'écriture si vous souhaitez exploiter vos descriptifs privés dans vos campagnes Open Edit
Ces trois manipulations sont décrites ci-dessous.
Création d'un projet de diffusion¶
Afin d'autoriser l'accès de vos fiches à Open Edit, il vous faut créer un projet de diffusion dans Apidae.
Pour cela, rendez-vous dans Diffuser => Projets => Mes projets
Utilisez le bouton Créer disponible en bas de l'écran
choisissez l'option Diffusion (API de lecture et exports)
Renseignez les informations ci-dessous Les mentions notées dans les champs Nom et Description sont données à titre indicatif, vous êtes libres d'appeler et de décrire votre projet de la façon dont vous le souhaitez :
- Nom : Open Edit - campagnes de mise à jour
- Type : formulaire de mise à jour
- État : en production
- Description : mise en place d'Open Edit dans le cadre de l'automatisation des campagnes de mise à jour
Puis enregistrez.
Sur l'onglet Informations générales de votre projet, complétez les informations de la partie Membres collaborateurs :
- Membre : Hôtentic
- Niveau de permission : configuration technique et contenu
- Notification : reçoit les emails de notifications
Enfin, basculez sur l'onglet Configuration technique et renseignez les informations suivantes :
- Technologies utilisées : API + Exports
- Fréquence de génération : quotidien
- Inclure les objets masqués : non
- Format : JSON
- Version du format de sortie : V2
- Grouper les objets exportées : oui
- Exporter les dates d'ouverture : non
- Inclure source : non
- Url de notification : https://admin.open-edit.io/apidae/import/callback
- Emails de notification : apidae@hotentic.com
- Adresses IP : -
Une fois votre projet créé, vous devrez ajouter les différentes sélections utiles à l'alimentation de vos campagnes Open Edit.
Création d'un projet d'écriture (si utilisation des descriptifs privés)¶
Note : La création d'un projet d'écriture est nécessaire si vous souhaitez exploiter vos descriptifs privés dans cos campagnes Open Edit. Si vous n'utilisez pas les descriptifs privés, le projet d'écriture n'est pas nécessaire.
En revanche, vous devrez obligatoirement vous abonner au projet multi-membre Open Edit - écriture (voir ci-dessous),
La création d'un projet d'écriture autorise Open Edit à apporter des modifications sur vos fiches, y compris pour vos données privées (descriptifs privés et critères internes).
Pour cela, comme pour le projet de diffusion, rendez-vous dans Diffuser => Projets => Mes projets
Utilisez le bouton Créer pour créer un nouveau projet
Choisissez Écriture (API d'écriture)
Sur le même principe que le projet de diffusion, renseignez les informations ci-dessous :
- Nom : Open Edit - Projet d'écriture
- Type : synchronisation en écriture avec une plateforme tiers
- État : en production
- Description : projet d'écriture pour la mise en place d'Open Edit
Puis enregistrez la création du projet.
-
Sur l'onglet Informations générales de votre projet, complétez les informations de la partie Membres collaborateurs :
-
Membre : Hôtentic
- Niveau de permission : configuration technique et contenu
- Notification : reçoit les emails de notifications
Enfin, basculez sur l'onglet Configuration technique et renseignez les informations suivantes :
- Actions autorisées : Création - Modification - Demande de suppression
- Types objets autorisés : ceux que vous souhaitez
- Auteur des écritures : vous
- Autoriser la validation directe : non
S'abonner au projet multi-membres Open Edit - écriture¶
Si vous avez déjà créé un projet d'écriture, vous n'avez pas besoin de vous abonner au projet multi-membres
Pour vous abonner au projet multi-membres Open Edit - Écriture, rendez-vous dans Diffuser => Projets => S'abonner
Puis, abonnez-vous via le picto pouce en bout de ligne du projet "Open Edit - écriture (4029)"