Zum Hauptinhalt springen
Diese Seite dokumentiert Änderungen, die speziell für die Devin-APIs (v1, v2 und v3) gelten. Versionshinweise zur Anwendung finden Sie unter Application Release Notes.
v3-API-Updates
- Notes- und Playbooks-Router (1. Dez.): Enterprise- und organisationsweite Endpunkte für die Verwaltung von Notes und Playbooks zur v3-API hinzugefügt. Notes-Endpunkte erfordern die Berechtigung
ManageAccountKnowledge, Playbooks-Endpunkte die Berechtigung ManageAccountPlaybooks.
v2 Enterprise API Updates
- Aktualisierung des Paginierungslimits (21. Nov): Maximales Paginierungslimit wurde von 1000 auf 200 Elemente pro Anfrage reduziert, um Leistung und Zuverlässigkeit zu verbessern. Das Standardlimit bleibt 100. Diese Änderung betrifft NICHT die v1 External API.
- Sessions-Router (16. Nov): Zur v2 API wurden umfassende Endpunkte für die Sitzungsverwaltung für Enterprise-Administratoren hinzugefügt.
- Snapshots-API-Endpunkt (3. Nov): Neuer Endpunkt zum programmgesteuerten Abrufen von Snapshot-Details.
v1 API Updates
- Endpunkt zum Beenden von Sitzungen (31. Okt): Neuer Endpunkt zum programmgesteuerten Beenden laufender Sitzungen.
v3-API-Launch (Beta)
- v3-API-Launch (23. Okt): Veröffentlichung der v3-API mit vollständiger RBAC-Unterstützung, Authentifizierungsmodell für Service-User und umfassendem Audit-Logging für Service-User-Aktionen.
v2-Enterprise-API-Updates
- Endpoint zur Snapshot-Erstellung (30. Okt): Neuer v2-Enterprise-Organizations-API-Endpunkt für Enterprise-Admins, um Repositories programmatisch zu klonen und Snapshots mit benutzerdefinierten Setup-Schritten und Startbefehlen zu erstellen.
- Verbesserungen an der Playbooks-API (14. Okt): Neue API zum Veröffentlichen von Enterprise-Playbooks mit verbesserter Funktionalität für die programmatische Playbook-Verwaltung.
v2 Enterprise-API-Updates
- Roles-Router (25. Sep.): Enterprise-Rollen-Router mit fünf API-Endpunkten hinzugefügt, um Rollen programmatisch zu verwalten.
v1-API-Updates
- Playbooks-API (6. Sep.): Umfassende Playbooks-API-Endpunkte zu v1 hinzugefügt, um Playbooks programmatisch zu erstellen, zu aktualisieren, aufzulisten und zu löschen.
- Secrets-Endpunkt (5. Sep.): Neuen
POST /v1/secrets-Endpunkt zum Erstellen von Secrets per API hinzugefügt.
Einführung der Enterprise-API v2
- API-v2-Einführung (23. März): Enterprise-API v2 für Enterprise-Administratoren mit Funktionen für Organisationsverwaltung, Nutzungsverfolgung und Mitgliederverwaltung eingeführt.
Einführung der v1-API (26. Okt.)
- REST-API für die programmgesteuerte Erstellung und Verwaltung von Sitzungen eingeführt
- Endpunkte für Erstellung, Überwachung und Verwaltung von Sitzungen
- Unterstützung für das Hoch- und Herunterladen von Dateianhängen
- Einfache Authentifizierung mit API keys
- Unterstützung für idempotente Sitzungserstellung
- Anwendungsfälle: automatische Reviews von Pull Requests (PRs), Behebung von Lint-Fehlern, Migrationen
Wir bemühen uns, innerhalb einer Hauptversion die Abwärtskompatibilität sicherzustellen. Nicht abwärtskompatible Änderungen werden:
- mindestens 7 Tage im Voraus angekündigt
- in diesen Versionshinweisen dokumentiert
- gegebenenfalls durch Migrationsleitfäden ergänzt
Wenn wir eine API-Funktion abkündigen:
- Ankündigung: Wir kündigen die Abkündigung mit einem Zeitplan an
- Abkündigungszeitraum: Die Funktion bleibt verfügbar, ist aber als veraltet gekennzeichnet
- Entfernung: Die Funktion wird nach Ablauf des Abkündigungszeitraums entfernt
- v1: Allgemein verfügbar, wird aktiv gewartet
- v2: Allgemein verfügbar, wird aktiv gewartet
- v3: Beta – Änderungen vorbehalten, für den Produktionseinsatz noch nicht empfohlen
Wenn Sie neue Integrationen mit fein granulierten Berechtigungen erstellen, sollten Sie v3 statt v1 verwenden:
Wesentliche Unterschiede:
- Authentifizierung: v3 erfordert Service-User-Tokens statt persönlicher/servicebezogener API keys
- Autorisierung: v3 bietet vollständiges RBAC mit rollenbasierten Berechtigungen
- Endpoints: v3 verwendet andere URL-Muster (
/v3beta1/* statt /v1/*)
Migrationsschritte:
- Erstellen Sie unter Enterprise Settings > Service Users einen Service User
- Weisen Sie dem Service User geeignete Rollen zu
- Generieren Sie einen API key für den Service User
- Aktualisieren Sie Ihre Integration, damit sie die v3-Endpoints verwendet
- Testen Sie alles gründlich in einer Nicht-Produktionsumgebung
v3 API-Dokumentation ansehen →
v3 bietet mehr Flexibilität als v2 für Enterprise-Automatisierung:
Wesentliche Unterschiede:
- Authentifizierung: v3 verwendet Service-Benutzer anstelle persönlicher Schlüssel von Enterprise-Administratoren
- Autorisierung: v3 unterstützt granuläres RBAC anstelle von ausschließlich Enterprise-Admin-Zugriff
- Geltungsbereich: v3 kann auf bestimmte Organisationen beschränkt werden, v2 gilt immer unternehmensweit
Wann Sie migrieren sollten:
- Sie benötigen Automatisierung mit Berechtigungen unterhalb der Admin-Ebene
- Sie möchten den API-Zugriff auf bestimmte Organisationen begrenzen
- Sie benötigen eine klare Trennung zwischen menschlichen Konten und Servicekonten
- Sie benötigen detaillierte Audit-Protokolle für automatisierte Aktionen
Bei Fragen zu API-Änderungen oder zur Unterstützung bei der Migration:
