Die Anwendung des Geschäftspartners (GP)

• Als Provider erstellt die Anwendung mit API PUT /messages/{ID} neue Meldungen mit einer eindeutigen ID (z.B. NT015) für eine BAZG Fachanwendung in die Input Queue A.

• Als Consumer fragt man mit API GET /messages ab, welche Meldungen (Liste von ID’s, messageType,..) in der Output Queue B vorhanden sind und liest mit API GET /message/{ID2} die Meldungen, welche von einer BAZG Fachanwendung erstellt wurden und verarbeitet diesen entsprechend den funktionalen Regeln der Anwendung.

Der B2B Hub bietet einen asynchronen Meldungsaustausch zwischen zwei Systemen, zum Beispiel GP-Anwendung und Passar.
Ein B2B Hub ist immer mit einer bestimmten BAZG Fachapplikation verbunden (beispielsweise Passar, Chartera Output oder LSVAIII). Er besteht aus zwei Meldungsqueues:

• Input Queue A: Eingehende Meldungen vom GP, welche von der BAZG Fachapplikation asynchron konsumiert werden.

• Output Queue B: Ausgehende Meldungen vom BAZG an das Geschäftspartner, welche periodisch von der GP-Anwendung gelesen und verarbeitet werden.

Die BAZG Fachanwendung wird mittels einem Event über eingehende Meldungen des GP informiert. Diese werden nach dem Eintreffen des Events von Queue A gelesen und entsprechend der Fachapplikationslogik verarbeitet. Anschliessend wird eine Antwortmeldung auf Queue B publiziert.

Abfrage Messages

GET

/messages

Gibt eine Liste von Meldungen in Form von messageIds für den authentisierten GP aus.
Filterung der Suche und Iteration über mehrere Meldungen ist je nach API Version möglich.

Lesen einer Message

GET

/messages/{messageId}

Gibt genau eine Meldung für den authentisierten Geschäftspartner und Meldungsidentifkation messageId zurück.

Lesen nächster Message mit einem Offset

GET

/messages/{messageId}/next

Gibt eine Meldung der Output Queue für den authentisierten GP (und optional topicName) zurück, welche chronologisch nach der Meldung mit der mitgegebenen messageId publiziert worden ist.
Dient der Iteration über Meldungen in chronologischer Reihenfolge. Diese Operation unterstützt nur sequenzielles Lesen von einzelnen Meldungen.

Übermitteln einer Meldung

PUT

/messages/{messageId}

Dient dem Übermitteln einer neuen Meldung in die Input Queue.

B2B HUB für PassarPreview

Meldungsaustausche zwischen Passar und nationalen Partnersysteme 

B2B HUB für Chartera OutputPreview

Bezug von Dokumenten durch die Partnersysteme

http Header message-type

Der messageType dient der eindeutigen Zuordnung einer gesendeten Meldung. Jede BAZG Anwendung (FA) hat unterschiedliche Meldungen definiert.

http Header partner-topic

http Header partner-external-reference

Diese Attribute können beim PUT gesetzt werden.
Sie dienen, um zwischen Meldungen des GP zu unterscheiden, welche mehrere (externe?) Systeme für die gleiche Fachanwendung verwenden.

http Header message-id

Bei GET /messages/{id}/next wird in der Antwortmeldung (HTTP Response) die message-id im HTTP Header der gelesenen Meldung übermittelt.

Query partnerTopic

Dieser Parameter wird in der Antwortmeldung vom Fachsystem geschrieben.

Query topicName

Dieser Parameter kann domänenspezifische (zum Beispiel import oder export) für die Zuweisung zu einem fachlichen Kontext verwendet werden.

query groupId

Die groupId gruppiert mehrere unterschiedliche Meldungen, welche fachlich/inhaltlich zusammengehören.

400 Bad Request

Der Aufruf ist fehlerhaft. Beispiele:

• erforderliche Parameter fehlen

• Parameter sind im falschen Format 

• Body in PUT ist kein gültiges XML

• <?xml version="1.0" encoding="utf-8"?> fehlt

• Konfiguration überprüfen

401 Unauthorized

• Im Request Header fehlt Authorization-Header mit dem JWT

• Bearer Token ist abgelaufen

• Refresh Tokens

• Falls Refresh Token abgelaufen ist neue Tokens via e-Portal generieren und in der Applikation übernehmen

403 Forbidden

• Keine Berechtigung für diesen Geschäftspartner (bpId)

• Fehlende Berechtigung für den B2B Hub der entsprechenden BAZG Fachanwendung

• Konfiguration überprüfen

• Richtige Token für richtige Umgebung

• Berechtigungen via ePortal beantragen

404 Not Found

• URL ist fehlerhaft

• No next Message found

Konfiguration überprüfen

415 Unsupported Media Type

Content-Type ist nicht application/xml (case-insensitive)

Header korrekt setzen

408 Request Timeout

B2B Hub hat nicht in der gewünschten Zeit geantwortet.

Request später nochmals senden.

500 Internal Server Error

B2B Hub hat ein internen Fehler

Request später nochmals senden.

Path messageId

http Header message-id

Eindeutige Identifikation einer Meldung, die übermittelt wird. Diese Identifikation wird vom Sender der Meldung gesetzt und muss als eine UUID Version 4 übermittelt werden.

Die messageId hat keine Beziehung zur messageIdentification innerhalb einer Meldung wie der NT015 - Warenanmeldung Durchfuhr (initial)Preview. Sie wird nur innerhalb vom B2B Hub der Fachanwendung verwendet.

http Header bp-id

Eindeutige, 10-stellige ID zur Identifikation des Geschäftspartners. Sie wird beim Onboarding eines Geschäftspartners der BAZG vergeben.

Query lastMessageId

Eindeutige Identifikation der letzten Meldung. Dieser Query Parameter wird verwendet, um die nächsten Meldungen nach einer vorherigen Abfrage zu suchen. Kann ähnlich wie ein Pointer/Offset angesehen werden. 

Query size

Anzahl der Meldungen, welche zurückgegeben werden (standardmässig 1000)

• Minium: 1

• Maximum: 1000