Aller au contenu principal

API v1 et clés API

Boldo propose maintenant une nouvelle API v1 sous /api/v1/, ainsi qu’une documentation API repensée et une expérience dédiée de gestion des clés API dans Organisation > Développeur.

Points clés​

  • Nouvelle API REST versionnée sous /api/v1/
  • Couverture des actifs, relations, recherche, analytics, métamodèle et clés API, avec accès en lecture aux utilisateurs, rôles et domaines d'accès
  • Sorties OpenAPI pour la nouvelle API
  • Documentation API reconstruite autour de la spécification v1
  • Nouvelle expérience de gestion des clés API dans Organisation > Développeur, avec des sections séparées pour Mes clés API et Clés API de l’organisation

Gestion des clés API​

La gestion des clés API est désormais beaucoup plus complète :

  • Plusieurs clés API par organisation au lieu d’un modèle à clé unique
  • Création, mise à jour et suppression depuis l’interface
  • Métadonnées par clé comme le nom et la description
  • Types de permission et rôles assignés
  • Secret affiché une seule fois au moment de la création

Changements de compatibilité​

  • L’API v1 devient l’API REST versionnée principale
  • L’authentification Bearer et la limitation du nombre de requêtes sont appliquées sur les routes v1
  • La documentation API est désormais générée à partir des spécifications OpenAPI de la v1
  • L’adressage par clé composite est pris en charge dans l’API v1

Également inclus dans cette version​

  • Création et mise à jour en masse des actifs, ainsi que création en masse des relations (jusqu’à 10 000 éléments par requête)
  • Endpoints de recherche avec prise en charge de filtres imbriqués pour les actifs et les relations
  • Endpoints d’agrégation analytique (count, sum, average, count distinct)
  • Création, lecture, mise à jour et suppression des clés API via l’API v1
  • Gestion des clés API dépendante du plan dans l’interface des paramètres d’organisation

Pourquoi c’est important​

Cette version rend l’API plus puissante, avec des droits plus complets et une meilleure prise en charge des intégrations de production.