Notes de version de l'API

• Routeurs Notes et Playbooks (1er déc.) : Ajout de points de terminaison de gestion des Notes et des Playbooks aux niveaux Enterprise et organisation dans l’API v3. Les points de terminaison Notes nécessitent l’autorisation ManageAccountKnowledge, les points de terminaison Playbooks nécessitent l’autorisation ManageAccountPlaybooks.

• Mise à jour de la limite de pagination (21 nov.) : Limite maximale de pagination réduite de 1000 à 200 éléments par requête pour de meilleures performances et une fiabilité accrue. La limite par défaut reste de 100. Ce changement n’affecte PAS l’API externe v1.
• Routeur de sessions (16 nov.) : Ajout de points de terminaison complets pour la gestion des sessions dans l’API v2, à destination des administrateurs Enterprise.
• Point de terminaison de l’API Snapshots (3 nov.) : Ajout d’un point de terminaison pour récupérer les détails des snapshots de manière programmatique.

• Point de terminaison pour mettre fin à une session (31 oct.) : Ajout d’un point de terminaison pour mettre fin aux sessions en cours de manière programmatique.

• Lancement de l’API v3 (23 oct.) : Lancement de l’API v3 avec prise en charge complète de la gestion des accès basée sur les rôles (RBAC), un modèle d’authentification via comptes de service et une journalisation d’audit exhaustive pour les actions de ces comptes de service.

• Endpoint de création de snapshot (30 oct.) : Nouvel endpoint de l’API Enterprise Organizations v2 permettant aux administrateurs Enterprise de cloner des dépôts de manière programmatique et de créer des snapshots avec des étapes de configuration personnalisées et des commandes de démarrage.
• Améliorations de l’API Playbooks (14 oct.) : Ajout d’une API pour publier des playbooks Enterprise avec des fonctionnalités améliorées pour la gestion programmatique des playbooks.

• Routeur de rôles (25 sept.) : Ajout d’un routeur Enterprise pour la gestion des rôles, avec cinq endpoints d’API permettant de gérer les rôles par programmation.

• API Playbooks (6 sept.) : Ajout d’endpoints complets de l’API Playbooks dans v1 pour créer, mettre à jour, lister et supprimer des playbooks par programmation.
• Endpoint Secrets (5 sept.) : Ajout du nouvel endpoint POST /v1/secrets pour créer des secrets via l’API.

• Lancement de l’API v2 (23 mars) : Mise à disposition de l’API Enterprise v2 pour les administrateurs Enterprise, avec des fonctionnalités de gestion des organisations, de suivi de la consommation et de gestion des membres.

• Lancement de l’API REST pour la création et la gestion de sessions par programmation
• Endpoints de création, de suivi et de gestion des sessions
• Prise en charge du chargement et du téléchargement de fichiers joints
• Authentification simple à l’aide d’API keys
• Prise en charge de la création de sessions idempotente
• Cas d’utilisation : revues automatiques de pull requests (PR), résolution d’erreurs de lint, migrations

​

Politique de gestion des versions de l’API

1. Annoncées au moins 7 jours à l’avance
2. Documentées dans ces notes de version
3. Accompagnées de guides de migration le cas échéant

1. Annonce : Nous annonçons la dépréciation avec un échéancier
2. Période de dépréciation : La fonctionnalité reste disponible mais est marquée comme dépréciée
3. Suppression : La fonctionnalité est supprimée après la période de dépréciation

• v1 : Généralement disponible et activement maintenue
• v2 : Généralement disponible et activement maintenue
• v3 : Bêta – susceptible d’évoluer, non encore recommandée pour un usage en production

• Authentification : v3 nécessite des jetons d’utilisateur de service au lieu de clés API personnelles/de service
• Autorisation : v3 fournit un RBAC complet (contrôle d’accès basé sur les rôles)
• Endpoints : v3 utilise des modèles d’URL différents (/v3beta1/* au lieu de /v1/*)

1. Créez un utilisateur de service dans Enterprise Settings > Service Users
2. Attribuez les rôles appropriés à l’utilisateur de service
3. Générez une API key pour l’utilisateur de service
4. Mettez à jour votre intégration pour utiliser les endpoints v3
5. Testez de manière approfondie dans un environnement hors production

• Authentification : v3 utilise des comptes de service au lieu d’exiger des clés personnelles d’administrateur Enterprise
• Autorisation : v3 prend en charge un RBAC granulaire au lieu d’un accès réservé aux administrateurs Enterprise
• Périmètre : v3 peut être limité à des organisations spécifiques, alors que v2 est toujours à l’échelle de l’Enterprise

• Vous avez besoin d’automatisations ne nécessitant pas de droits d’administrateur
• Vous souhaitez limiter l’accès à l’API à des organisations spécifiques
• Vous avez besoin d’une séparation claire entre comptes utilisateurs et comptes de service
• Vous exigez des journaux d’audit détaillés pour les actions automatisées

• Email : [email protected]
• Documentation : Présentation de l’API
• Guide d’authentification : Authentication & API Keys