Documentation technique

Configuration

Comme pour la diffusion, la mise en oeuvre des API en écriture nécessite la mise en place d’un projet d’un type spécifique.

Configuration du projet

L’utilisation de l’API d’écriture nécessite l’utilisation d’un projet de type particulier dans Apidae. Le type de projet « API d’écriture » est réservé à cet usage.

Une fois autorisé par Apidae à utiliser les projets de cet type, votre client doit créer un projet puis vous ajouter en tant que collaborateur sur celui-ci.

projet_ecriture_configuration
Il est également nécessaire de configurer correctement le projet avant de pouvoir utiliser l’API. Sur l’onglet « Configuration Technique » plusieurs informations doivent être renseignées selon l’utilisation du projet :

  • Actions autorisées : la liste des actions d’écriture autorisées pour les appels liés à ce projet (parmi « Création », « Modification » et « Suppression »).
  • Types d’objets autorisés : la liste de types d’objets qui peuvent être manipulés par les appels liés à ce projet.
  • Auteur des écritures : compte utilisateur qui sera désigné comme auteur des modifications faites par les appels liés à ce projet.
  • Autoriser la validation directe : détermine si les appels liés à ce projet peuvent ou non demander une validation directe (i.e. publier directement les modifications si aucune erreur de validation n’est remontée sur l’objet).

Les modifications / demandes de suppression sont limitées aux fiches dont le membre du projet est propriétaire.

Authentification des appels

L’authentification des appels est basé sur OAuth2.
Ce type d’authentification nécessite la création d’un client OAuth sur le projet Apidae qui sera utilisé pour les appels. Pour plus de détails sur la création et l’utilisation du client OAuth, voir la page Client OAuth.
Pour l’authentification des appels à l’API avec la méthode « Client credentials », se reporter à la page Authentification OAuth.