API Dokumentation

Login

Aufzurufende URL (POST)

https://api.login.documedia.at/login_check

Zu übergebender Header

Content-Type: application/json X-FORCE-LOGIN: true

Zu übergebende Daten (JSON)

username: [User] password: [Passwort]

Ergebnis

Ein erfolgreicher Login liefert einen JWT-Token und einen entsprechenden Refresh-Token. Der JWT-Token wird für jeden weiteren Kontakt mit der Schnittstelle benötigt. Der Refresh-Token wird benötigt um einen neuen Token anzufordern (dies sollte nicht erforderlich sein, der Token ist eine Stunde lang gültig).

token: eyJ0eXAiwqiJKV1QiLCJhbGciO ... refresh_token: 20cd2170ef59651c5c ...

Zusätzlich wird im Header der Antwort ein Security Cookie gesendet. Das Cookie muss bei jedem weiteren Aufruf ebenfalls im Header mitgesendet werden.

Anfordern eines neuen Tokens

Ein neuer JWT-Token kann angefordert werden, um die Laufzeit der Session zu verlängern. Das Anfordern eines neuen Tokens sollte in der Regel nicht erforderlich sein, da der JWT-Token eine Stunde lang gültig ist.

Aufzurufende URL (POST)

https://api.login.documedia.at/token/refresh

Zu übergebender Header

Cookie: security=[Security Cookie]

Zu übergebende Form Daten

refresh_token: 20cd2170ef59651c5c ...

Ergebnis

Das Ergebnis ist identisch mit dem Login.

Daten abholen

Beim Abrufen der Daten werden maximal die ersten 10 Datensätze bei Projekten bzw. die ersten 20 Datensätze bei Bekanntmachungen aus der Queue geliefert. Erst nach Bestätigung der Abholung wird das nächste Paket geliefert.

Die Suchprofil-ID muss als URL-Parameter übergeben werden.

Aufzurufende URL (GET)

https://api.login.documedia.at/web_service/all_pn_headers?searchProfile=[Suchprofil-ID] für Ausschreibungen

https://api.login.documedia.at/web_service/projects?searchProfile=[Suchprofil-ID] für Bauprojekte

Zu übergebender Header

Authorization: Bearer [JWT Token] Accept: [Datenformat] Cookie: security=[Security Cookie]

Über den Parameter Accept wird gesteuert, in welchem Format die Daten zurückgeliefert werden sollen. Folgende Formate sind möglich:

JSON application/json XML application/xml JSON-LD application/ld+json

Ergebnis

Es werden die nächsten Datensätze im gewünschten Format geliefert.

Abholung bestätigen

Um eventuell auftretende Fehler behandeln zu können, muss die Abholung von Daten explizit bestätigt werden. Erst nach der Bestätigung werden die nächsten Daten aus der Queue geliefert.

Aufzurufende URL (POST)

https://api.login.documedia.at/web_service/acknowledge

Zu übergebender Header

Authorization: Bearer [JWT Token] Content-Type: application/json Cookie: security=[Security Cookie]

Zu übergebende Daten (JSON)

ids: [Array mit den IDs, die bestätigt werden sollen] searchProfile: [Suchprofil-ID]

Ergebnis

Der Aufruf liefert keine Daten.

Logout

Aufzurufende URL (GET)

https://api.login.documedia.at/logout

Zu übergebender Header

Authorization: Bearer [JWT Token] Cookie: security=[Security Cookie]

Ergebnis

Der Aufruf liefert keine Daten.