Mit dem Modul REST Schnittstelle können Vergaben der RIB e-Vergabeplattform medienbruchfrei an ein Dokumentenmanagementsystem oder Archivsystem übergeben werden. Hierbei bieten wir eine Standard-Funktion über ein modernes REST API, die je nach Zielsystem des Kunden dann noch individuell angepasst bzw. konfiguriert werden kann.
Die REST Schnittstelle vermeidet Medienbrüche, ermöglicht eine sichere und einfache Datenübergabe und unterstützt den zuverlässigen Datenaustausch, zum Beispiel zur Archivierung von Vergabeverfahren in einem Dokumentenmanagementsystem innerhalb der IT-Landschaft einer Vergabestelle.
So können Dokumente, die vom Anwender angelegt, bearbeitet und abgespeichert wurden, in DMS/Archiv Systemen weiterverarbeitet, abgespeichert und gesucht werden.
Das Modul bietet folgende Funktionen:
•Zentraler Zugriff auf die API über das Internet inklusive Basis-Authentifikation
•Integration in bestehende Systeme über eine REST API
•Anbindung an vorhandene Portale und Webclients/-services
•Offene Schnittstellenarchitektur
•Revisionssichere digitale Archivierung durch Übergabe an ein Archivsystem
Technische Beschreibung
Die Lösung ist als REST Service mit Basis-Authentifikation (Basic-Authentication) und Chunked Downloads umgesetzt. Die Basis-Authentifikation wird im Browser als Popup-Fenster dargestellt.
Als Webserviceaufruf, z.B. mit CURL oder SoapUI, können Werte über den http-Header direkt übergeben werden.
Authentifizierung
Für eine Authentifizierung benötigen Sie die Zugangsdaten einer, auf der entsprechenden Plattform angemeldeten, Person. Hierfür ist der Benutzername und das Passwort, also die Zugangsdaten der Plattform, erforderlich.
Fehlermeldungen
Im Fehlerfall wird der HTTP Response-Code 400 mit einer entsprechenden, eindeutigen Fehlermeldung zurückgeliefert.
Rückmeldungen
Alle Rückmeldungen sind im JSON Format (ausgenommen der Download der ZIP Datei).
Pakete
Der Aufruf kann für sogenannte Datenpakete ausgeführt werden. Datenpakete oder auch Pakete genannt, beinhalten jeweils die Daten und Dokumente des ausgewählten Platzformprozesses. So gibt es zum Beispiel ein Paket mit dem Namen "PB_Vergabeunterlagen" für Vergabeunterlagen. Aktuell werden folgende Pakete zur Verfügung gestellt:
0 "PB_Vorvermerk"
1 "PB_Bekanntmachungen"
2 "PB_TED_F02"
3 "PB_Teilnahmewettbewerb"
4 "PB_Vergabeunterlagen"
5 "PB_Aenderungen_VU"
6 "PB_Firmenliste"
7 "PB_Bieterfragen"
8 "PB_Eroeffnung"
9 "PB_Nachtragsprotokolle"
10 "PB_Pruefung_Wertung"
11 "PB_Bindefristverlaengerung"
12 "PB_Zuschl_Absage"
13 "PB_Kommunikation"
14 "PB_Kom_Vorschlagsliste"
15 "PB_Kom_Firmenliste"
16 "PB_Kom_Pruefung"
17 "PB_Komm_Bewerberliste"
18 "PB_Vergabevermerk"
19 "PB_Vergabeakte"
20 "PB_Bieterkommunikation"
21 "PB_TED_02_01_14"
22 "PB_csbf"
23 "PB_Aufhebung"
24 "PB_Vergabeinfo"
25 "PB_Dateiablage"
26 "PB_Table_Of_Content"
Beispiele
Die folgenden Beispielaufrufe basieren auf der Testplattform https://test.arriba-net.de. Für die Nutzung auf einer Produktivplattform, zum Beispiel https://my.vergabe.rib.de ist der Aufruf der unten genannten Beispiel entsprechend anzupassen. Sie benötigen immer Benutzername und Passwort, also die Zugangsdaten der Plattform.
Alle Maßnahmen anzeigen (get_all_projects)
Es sollen alle Maßnahmen des Mandanten angezeigt werden.
https://test.arriba-net.de/docexpapi/get_all_projects
Alle Vergaben einer Maßnahme anzeigen (get_all_tenders)
Es sollen alle Vergaben in der Maßnahme-Nummer "M500A" angezeigt werden.
https://test.arriba-net.de/docexpapi/get_all_tenders?project_nr=M500A
Alle möglichen Pakete auflisten (list_packages)
Es sollen alle möglichen Datenpakete angezeigt werden. Für jeden Prozess der Plattform, wie zum Beispiel Vergabeunterlagen oder Kommunikation wird ein eigenes Datenpaket, mit den darin enthaltenen Daten und Dokumenten, erzeugt. Dieses kann einzeln geladen werden.
https://test.arriba-net.de/docexpapi/list_packages
Alle Daten einer Vergabe laden (get_all_packages)
Es sollen alle Dokumente zur Vergabe-Nummer "V4711" in der Maßnahme-Nummer "M500A" geladen werden. Diese Funktion nimmt alle vorhandenen Datenpakete der Vergabe.
https://test.arriba-net.de/docexpapi/get_all_packages?project_nr=M500A&tender_nr=V4711
Ein bestimmtes Paket laden: Nur Vergabeunterlagen (get_package)
Es sollen die Vergabeunterlagen zur Vergabe-Nummer "V4711" in der Maßnahme-Nummer "M500A" geladen werden.
Ein bestimmtes Paket laden: Nur Kommunikation (get_package)
Es sollen die Daten der Kommunikation zur Vergabe-Nummer "V4711" in der Maßnahme-Nummer "M500A" geladen werden.
Ein bestimmtes Paket laden: Nur Dokumente der Dateiablage (get_package)
Es sollen alle Dokumente aus der Dateiablage zur Vergabe-Nummer "V4711" in der Maßnahme-Nummer "M500A" geladen werden.
Beispiel mit CURL
Es sollen alle Daten der kompletten Vergabe "V4711" in der Maßnahmen "M500A" geladen und diese Daten in einem ZIP-Archiv auf dem Computer unter "C:\temp\datei.zip" gespeichert werden. Für diesen Aufruf ist der Username und das Passwort (Zugangsdaten der Plattform) erforderlich.
Wenn Sie mit CURL arbeiten, setzen Sie die URL und den Parameter immer in Anführungszeichen.
curl -u username:passwort "https://test.arriba-net.de/docexpapi/get_all_packages?project_nr=M500A&tender_nr=V4711" --output "C:\temp\datei.zip"
