Skip to main content

​
Übersicht

Die comstruct API bietet eine RESTful-Schnittstelle zur Verwaltung der Baumaterial-Beschaffung. Diese Referenz dokumentiert alle verfügbaren Endpunkte mit interaktiven “Try it”-Funktionen.

​
Basis-URL

Alle API-Anfragen sollten an folgende Adresse gesendet werden:
Kalender- (/calendars/...) und IDS-Endpunkte (/ids/...) verwenden die Basis-URL https://api.comstruct.com ohne das /v1-Präfix.

​
Authentifizierung

Alle Endpunkte erfordern API-Schlüssel-Authentifizierung über den x-api-key-Header:

​
Berechtigungen (Scopes)

API-Schlüssel haben spezifische Berechtigungen im Format ressource:aktion. Jeder Endpunkt erfordert nur die für ihn relevanten Scopes – die erforderlichen Berechtigungen werden pro Endpunkt angezeigt. Verfügbare Berechtigungen:
Als Administrator können Sie API-Schlüssel selbst in der comstruct-Anwendung erstellen: Administration → API-Schlüssel. Dort legen Sie Berechtigungen (Scopes) fest und erhalten den Schlüssel einmalig bei der Erstellung.Alternativ hilft Ihnen Ihr Customer Success Manager bei der Einrichtung.

​
API-Endpunkt-Gruppen

Projekte

Projektverwaltung und -abfragen.
  • Projekte auflisten
  • Projekt erstellen/aktualisieren
  • Projekt nach ID abrufen
  • Projektkomponenten abrufen
  • SAP-Projekte importieren

Lieferungen

Lieferschein-Verwaltung.
  • Lieferungen auflisten
  • Lieferscheine erstellen
  • Lieferung aktualisieren und Lieferkomponenten setzen
  • OpenTrans/PAHM/Custom-Formate

Rechnungen

Rechnungsverarbeitung.
  • Rechnungen auflisten und einzeln abrufen
  • Rechnungen hochladen
  • KI-gestützte Analyse

Stammdaten

Referenzdaten verwalten.
  • Konten
  • Zahlungsbedingungen
  • Steuercodes
  • Buchungskreise
  • Projektregionen

​
Ratenlimits

Die API setzt Ratenlimits ein, um eine faire Nutzung und Systemstabilität zu gewährleisten. Limits gelten pro IP-Adresse. Bei Überschreitung des Limits können Anfragen gedrosselt oder mit HTTP 403 Forbidden abgelehnt werden. Implementieren Sie Exponential-Backoff und Retry-Logik in Ihren Integrationen, um Ratenlimit-Antworten zuverlässig zu verarbeiten.
Bei Integrationen mit hohem Aufkommen kontaktieren Sie Ihren Customer Success Manager, um Ihre Anforderungen zu besprechen.

​
HTTP-Statuscodes

​
Interaktive API-Dokumentation

Jede Endpunkt-Seite enthält eine “Try it”-Funktion, mit der Sie API-Aufrufe direkt testen können. Geben Sie einfach Ihren API-Schlüssel ein und testen Sie die Endpunkte.

OpenAPI-Spezifikation

Laden Sie die vollständige OpenAPI 3.0 Spezifikation herunter.