active archive – Dokumentabruf per REST-Service

Mit der Version 3.6 unseres Archivdienstes active archive ng haben wir für Sie unser umfangreiches Leistungsportfolio erweitert.

Mit dieser Version ist es Ihnen als Kunde unseres Archivdienstes noch einfacher möglich, Belegdaten auf sichere und performante Weise abzurufen und unseren Service noch enger an Ihre Inhouse-Systeme zu koppeln.

Dokumentabruf ohne Sendungsdaten? – Kein Problem

Ab dieser Version ist es auch problemlos möglich, ihre Dokumentdaten schnittstellenbasiert abrufen zu können, ohne dass Sie uns zuvor die zugehörigen Sendungsdaten übermitteln müssen. Es genügt die Referenznummer.
Bitte beachten Sie, dass Sie in diesem Fall auf Ihrer Seite zusätzliche Prüfungen vornehmen müssen, bevor Sie die Dokumente an Dritte weitergeben. Eine Berechtigungsprüfung durch uns kann nur noch auf Basis des archivierenden Betriebes erfolgen.

(1) Die Anmeldung
Die Anmeldung am REST-Service erfolgt per Standard HTTP-BASIC-AUTH-Verfahren (https://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication). Verwenden Sie hierzu einfach ihre Anmeldedaten, die Sie auch bisher für den Zugriff auf das Archiv verwendet haben. Sollten Sie noch keinen Benutzer haben, erhalten Sie als Archivkunde einen Account bei unserem Support.

Der HTTP-Header mit den BASIC-AUTH Anmeldedaten muss bei jedem Request mitgesendet werden. Es wird keine langlaufende Sitzung auf dem System geführt.

(2.1) Suche nach Dokumenten über Sendungsdaten
Der Dokumentabruf kann über Begriffe der zugehörigen Sendung erfolgen. Voraussetzung hierfür ist, dass die Sendungsdaten zur Archivierung mit in der zentralen Datenbank abgelegt werden. Dies ist z.B. bei allen unseren active tracking ng Kunden der Fall.

GET

https://dms.active-logistics.com/optarchive/rest/v1/consignment/documents?consignmentYear=2019&docType=ALL&senderDepot=1234&consignmentNumberSender=1234567890123

Bei den Parametern zur Sendung können Sie wahlweise die Parameter des Versandbetriebes (Alternative A) oder die Parameter des Empfangsbetriebes (Alternative B) verwenden; eines der beiden Parameterpaare muss aber vorliegen.

Parameter

Beschreibung

consigmentYear

Das Versandjahr der Sendung im Format YYYY

consignmentNumberSender

Sendungsnummer der Versandbetriebes

Alternative A

senderDepot

Betriebskennung des Versandbetriebes

Alternative A

consignmentNumberRecipient

Sendungsnummer der Empfangsbetriebes

Alternative B

recipientDepot

Betriebskennung des Empfangsbetriebes

Alternative B

docType

Gewünschte Dokumententypen

ALL – Alle Dokumente

POD – Nur Ablieferbelege

DAMAGE – Nur Schadensdokumente

DELIVERYNOTE – Nur Lieferscheine

Als Ergebnis der Abfrage erhalten Sie eine Liste im JSON-Format mit den passenden Dokumenten. Zu jedem Dokument erhalten Sie die ID mit der Sie das Dokument abrufen können (Schritt (3)).

[
{
„docType“: „POD“,
„docID“: „2019012809513941200087139FEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE“
}
]

(2.2) Suche nach Dokumenten über die Referenznummer
Alternativ kann ein Dokument über die Referenznummer gesucht werden. Der Referenzbegriff wird bei der Einrichtung von active archive mit Ihnen abgestimmt. In der Regel handelt es sich um die Sendungsnummer des Empfangspartners der Sendung.

GET
https://dms.active-logistics.com/optarchive/rest/v1/documents?searchTerm=12345678&year=2019&depot=1234&docType=POD

Parameter

Beschreibung

searchTerm

Die Referenznummer. In den meisten Fällen die Sendungsnummer des Empfangspartners

year

Das Jahr der Archivierung im Format YYYY

depot

Betriebskennung des archivierenden Betriebes

docType

Gewünschte Dokumententypen

ALL – Alle Dokumente

POD – Nur Ablieferbelege

DAMAGE – Nur Schadensdokumente

DELIVERYNOTE – Nur Lieferscheine

Als Ergebnis der Abfrage erhalten Sie eine Liste im JSON-Format mit den passenden Dokumenten. Zu jedem Dokument erhalten Sie die ID, mit der Sie das Dokument abrufen können (Schritt (3)).

[
{
„docType“: „POD“,
„docID“: „2019012809513941200087139FEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE“
}
]

(3) Dokumenten über die docID abrufen
Mit der docID aus Schritt 2.1 bzw. 2.2 können dann die Dokumente abgerufen werden. Dazu die docID einfach in der URL anhängen. Parameter sind nicht notwendig.

GET
https://dms.active-logistics.com/optarchive/rest/v1/documents/2019012809513941200087139FEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE

Als Antwort des Requests erhalten Sie direkt den Datenstrom des Dokuments.