API-Dokumentation (API Documentation / Schnittstellendokumentation)
API-Dokumentation beschreibt alle Endpunkte, Authentifizierungsanforderungen, Datenformate, Fehlercodes und Nutzungsgrenzen einer Schnittstelle so, dass externe Entwickler die API korrekt und sicher integrieren können. Im Vergabekontext sollten Auftraggeber bei IT-Systemen mit externen Schnittstellen vollständige und aktuelle API-Dokumentation als Vertragsbestandteil (z. B. OpenAPI/Swagger-Spezifikation) fordern. Das BSI empfiehlt, API-Dokumentationen als Teil des Sicherheitskonzepts zu behandeln, da unvollständige Dokumentation undokumentierte Angriffsflächen schafft.
Quellen: BSI: Vergaben an Externe, bsi.bund.de · §31 VgV (Leistungsbeschreibung), gesetze-im-internet.de
Im Vergabe-Archiv nach »API-Dokumentation« suchen →
Verwandte Begriffe
Authentifizierungsprotokoll API-Management Auditprotokoll Audit-Trail AuditierbarkeitBrauchen Sie technische Zuarbeit für eine IT-Ausschreibung?
IT-LV liefert technische Muster-Leistungsverzeichnisse und technische Zuarbeit. Rechtsberatung erbringen wir nicht; Verfahrenswahl, Fristen und Wertung liegen bei Ihrer Vergabestelle.