Ü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:
| Berechtigung | Beschreibung |
|---|---|
projects:read/write | Projektdaten lesen/schreiben |
deliveries:read/write | Lieferdaten lesen/schreiben |
invoices:read/write | Rechnungsdaten lesen/schreiben |
suppliers:write | Lieferanten erstellen/aktualisieren |
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
- Projektregionen
HTTP-Statuscodes
| Code | Beschreibung |
|---|---|
200 | Erfolg |
201 | Erfolgreich erstellt |
400 | Ungültige Anfrage |
401 | Nicht autorisiert |
403 | Verboten - fehlende Berechtigung |
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.