Ü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-Endpunkte verwenden die Basis-URL
https://api.comstruct.com ohne das /v1-Präfix.Authentifizierung
Alle Endpunkte erfordern API-Schlüssel-Authentifizierung über denx-api-key-Header:
Berechtigungen (Scopes)
API-Schlüssel haben spezifische Berechtigungen im Formatressource:aktion. Jeder Endpunkt erfordert nur die für ihn relevanten Scopes – die erforderlichen Berechtigungen werden pro Endpunkt angezeigt.
Verfügbare Berechtigungen:
| Berechtigung | Beschreibung |
|---|---|
projects:read | Projektdaten lesen |
projects:write | Projekte erstellen und ändern |
deliveries:read | Lieferdaten lesen |
deliveries:write | Lieferungen erstellen und ändern |
invoices:read | Rechnungsdaten lesen |
invoices:write | Rechnungen erstellen und ändern |
project_regions:read | Projektregionsdaten lesen |
project_regions:write | Projektregionen erstellen und ändern |
accounts:read | Kontodaten lesen |
accounts:write | Konten erstellen und ändern |
payment_terms:read | Zahlungsbedingungsdaten lesen |
payment_terms:write | Zahlungsbedingungen erstellen und ändern |
tax_codes:read | Steuercodedaten lesen |
tax_codes:write | Steuercodes erstellen und ändern |
legal_entities:read | Buchungskreise lesen |
legal_entities:write | Buchungskreise erstellen und ändern |
users:read | Benutzerdaten lesen (Projekt-Benutzerverwaltung) |
roles:read | Rollendaten lesen (Projekt-Rollenzuweisung) |
tenant_settings:read | Mandanteneinstellungen lesen |
suppliers:write | Lieferanten erstellen und ändern |
purchase_orders:write | Bestellungen erstellen |
Kontaktieren Sie Ihren Customer Success Manager, um Ihren API-Schlüssel mit den benötigten Berechtigungen zu erhalten.
API-Endpunkt-Gruppen
Projekte
Projektverwaltung und -abfragen.
- Projekte auflisten
- Projekt erstellen/aktualisieren
- Projekt nach ID abrufen
- SAP-Projekte importieren
Lieferungen
Lieferschein-Verwaltung.
- Lieferungen auflisten
- Lieferscheine erstellen
- OpenTrans/PAHM/Custom-Formate
Rechnungen
Rechnungsverarbeitung.
- Rechnungen auflisten
- 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.| Limit | Wert |
|---|---|
| Anfragenanzahl | 750 Anfragen |
| Intervall | 30 Sekunden |
403 Forbidden abgelehnt werden. Implementieren Sie Exponential-Backoff und Retry-Logik in Ihren Integrationen, um Ratenlimit-Antworten zuverlässig zu verarbeiten.
HTTP-Statuscodes
| Code | Beschreibung |
|---|---|
200 | Erfolg |
201 | Erfolgreich erstellt |
400 | Ungültige Anfrage |
401 | Nicht autorisiert |
403 | Verboten – fehlende Berechtigung oder Ratenlimit überschritten |
404 | Nicht gefunden |
500 | Serverfehler |
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.