Aller au contenu principal

API

Utilisez cette page lorsque vous voulez intégrer Boldo avec un autre système ou automatiser du travail sur la base de connaissances.

Le flux API comporte deux parties :

  • la page Développeur, où vous gérez la clé API
  • la page publique de documentation API, où vous pouvez vous authentifier et tester les requêtes prises en charge

Disponibilité​

Plan requis

L'accès API dépend de votre plan. Vérifiez Organisation → Développeur pour confirmer votre accès.

Générer votre clé API​

  1. Cliquez sur l'icône Organisation
  2. Sélectionnez "Développeur"
  3. Cliquez sur "Générer" si aucune clé n'existe encore
  4. Affichez la clé si nécessaire
  5. Cliquez sur "Copier la clé API" pour la copier

Si une clé existe déjà, en générer une nouvelle invalide immédiatement la précédente.

Limitation actuelle

Pour l'instant, Boldo ne prend en charge qu'une seule clé API par organisation.

Cette clé donne un accès complet à l'API pour l'organisation.

Sécurité
  • Ne partagez jamais votre clé API
  • Ne l'enregistrez pas dans le contrôle de version
  • Régénérez-la immédiatement si vous pensez qu'elle a été exposée

Utiliser la documentation API​

La documentation API interactive est l'endroit le plus sûr pour voir ce que l'environnement actuel prend en charge.

Elle vous permet de :

  • vous authentifier avec votre clé API
  • vérifier que la clé fonctionne avant d'écrire vos propres scripts
  • inspecter le format des requêtes et des réponses
  • tester des requêtes réelles sur votre environnement

Quand utiliser l'API​

Utilisez l'API lorsque vous avez besoin d'un travail répétable ou programmatique sur la base de connaissances.

Cas typiques :

  • intégrer Boldo avec un autre système
  • exécuter des synchronisations récurrentes
  • automatiser des mises à jour répétées
  • construire des scripts ou des outils internes sur Boldo

Utilisez plutôt Importer un fichier CSV lorsque le besoin est un import en masse ponctuel géré par des utilisateurs métier.

Utilisez l'interface lorsque vous mettez à jour quelques actifs manuellement, ajustez le métamodèle, ou exportez un CSV ou une image ponctuels depuis l'écran actuel.