INEX XML-Schnittstelle Lieferservice
Über diese XML-Schnittstelle können die Daten vom INEX ohne eine aufwändige BiPRO-Implementierung abgerufen werden. Lieferungen enthalten zum Beispiel die Maklerpost, aber auch Informationen zur Verarbeitung der Anträge im IMA oder, GDV-Daten oder Abrechnungsdaten. Die Lieferungen werden vom INEX chronologisch zur Verfügung gestellt. Verarbeitete Lieferungen sollten durch die abholende Software bestätigt werden.
- Sicherheits-Token abrufen
- Liste der Lieferungen
- Lieferung abrufen
- Lieferung bestätigen
Kapitelübersicht
Sicherheits-Token abrufen
Benutzername und Passwort entsprechen den Zugangsdaten zum INEX-Account. Es wird empfohlen, das Passwort in der eigenen Software nicht zu speichern und stattdessen das Token für wiederholte Abrufe zu speichern.
URL:
https://inex.inveda.net/services/SecurityTokenService_1_0_0_0/
Schema:
https://inex.inveda.net/services/SecurityTokenService_1_0_0_0/?wsdl
https://inex.inveda.net/services/SecurityTokenService_1_0_0_0/?xsd=inex/1.0.0/SecurityTokenService_1.0.0.0.xsd
Request:
<inex:Message xmlns:inex="http://inex.inveda.net">
<inex:Header>
<inex:Security>
<inex:UsernameToken>
<inex:Username>[Benutzername]</inex:Username>
<inex:Password>[Passwort]</inex:Password>
</inex:UsernameToken>
</inex:Security>
</inex:Header>
<inex:Body>
<inex:RequestSecurityToken>
<inex:TokenType>http://inex.inveda.net/token</inex:TokenType>
</inex:RequestSecurityToken>
</inex:Body>
</inex:Message>
Response:
<inex:Message xmlns="http://inex.inveda.net" xmlns:inex="http://inex.inveda.net">
<inex:Header/>
<inex:Body>
<inex:RequestSecurityTokenResponse>
<inex:TokenType>http://inex.inveda.net/token</inex:TokenType>
<inex:RequestedSecurityToken>
<inex:SecurityContextToken>
<inex:Identifier>0eadd7e1846c05efef54a85f49a4d673-2c3b4d0f-b66a-4023-8377-e164a55d145e</inex:Identifier>
</inex:SecurityContextToken>
</inex:RequestedSecurityToken>
<inex:Lifetime>
<inex:Created>2020-05-11 10:17:15</inex:Created>
<inex:Expires>2020-05-12 10:17:15</inex:Expires>
</inex:Lifetime>
</inex:RequestSecurityTokenResponse>
</inex:Body>
</inex:Message>
Liste der Lieferungen
Es wird eine Liste der vorhanden Datenlieferungen zurückgegeben. Optional können bereits bestätigte Lieferungen angefragt werden.
URL:
https://inex.inveda.net/services/TransferService_1_0_0_0/
Schema:
https://inex.inveda.net/services/TransferService_1_0_0_0/?wsdl
https://inex.inveda.net/services/TransferService_1_0_0_0/?xsd=inex/1.0.0/TransferService_1.0.0.0.xsd
https://inex.inveda.net/services/TransferService_1_0_0_0/?xsd=inex/1.0.0/INEX_1.0.0.0.xsd
https://inex.inveda.net/services/TransferService_1_0_0_0/?xsd=inex/1.0.0/IMA_1.0.0.0.xsd
Request:
<inex:Message xmlns:inex="http://inex.inveda.net" xmlns="http://inex.inveda.net">
<inex:Header>
<inex:Security>
<inex:SecurityContextToken>
<inex:Identifier>[Token]</inex:Identifier>
</inex:SecurityContextToken>
</inex:Security>
</inex:Header>
<inex:Body>
<inex:listShipments>
<inex:Request>
<inex:Version>1.0.0.0</inex:Version>
<inex:ConsumerID>[CONSUMER]</inex:ConsumerID>
<inex:KategorieDerLieferung>[optional: Kategorie]</inex:KategorieDerLieferung>
<inex:BestaetigeLieferungen>false</inex:BestaetigeLieferungen>
</inex:Request>
</inex:listShipments>
</inex:Body>
</inex:Message>
Response:
<inex:Message xmlns="http://inex.inveda.net" xmlns:inex="http://inex.inveda.net">
<inex:Header/>
<inex:Body>
<inex:listShipmentsResponse>
<inex:Response>
<inex:Version>1.0.0.0</inex:Version>
<inex:Status>
<inex:ProzessID>12542966165eb90bf15d102930709345</inex:ProzessID>
<inex:Zeitstempel>2020-05-11T10:25:22</inex:Zeitstempel>
<inex:StatusID>OK</inex:StatusID>
<inex:Meldung>
<inex:ArtID>Hinweis</inex:ArtID>
<inex:MeldungID>01000</inex:MeldungID>
<inex:Text>Lieferungen vorhanden</inex:Text>
</inex:Meldung>
</inex:Status>
<inex:Lieferung>
<inex:ID>4</inex:ID>
<inex:Einstellzeitpunkt>2020-04-29T15:31:37</inex:Einstellzeitpunkt>
<inex:Kategorie>Antrag_Allgemein_Sonstiges</inex:Kategorie>
<inex:KategorieBiPRO>100000000</inex:KategorieBiPRO>
<inex:ArtDerLieferung>GeVoInitial</inex:ArtDerLieferung>
<inex:Stichtag>2020-04-29T15:31</inex:Stichtag>
<inex:EnthaeltNurDaten>false</inex:EnthaeltNurDaten>
<inex:PeriodischeLieferung>false</inex:PeriodischeLieferung>
<inex:AnzahlTransfers>25</inex:AnzahlTransfers>
</inex:Lieferung>
...
</inex:Response>
</inex:listShipmentsResponse>
</inex:Body>
</inex:Message>
Lieferung abrufen
Gibt eine einzelne Daentlieferung zurück. Die Lieferung enthält Dokumente, als auch Daten zu Partnern und zum Vertrag.
URL:
https://inex.inveda.net/services/TransferService_1_0_0_0/
Request:
<inex:Message xmlns:inex="http://inex.inveda.net" xmlns="http://inex.inveda.net">
<inex:Header>
<inex:Security>
<inex:SecurityContextToken>
<inex:Identifier>[Token]</inex:Identifier>
</inex:SecurityContextToken>
</inex:Security>
</inex:Header>
<inex:Body>
<inex:getShipment>
<inex:Request>
<inex:Version>1.0.0.0</inex:Version>
<inex:ConsumerID>[CONSUMER]</inex:ConsumerID>
<inex:ID>[ID Lieferung]</inex:ID>
</inex:Request>
</inex:getShipment>
</inex:Body>
</inex:Message>
Response:
<inex:Message xmlns="http://inex.inveda.net" xmlns:inex="http://inex.inveda.net">
<inex:Header/>
<inex:Body>
<inex:getShipmentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<inex:Response>
<inex:Version>1.0.0.0</inex:Version>
<inex:Status>
<inex:ProzessID>19797959355eb90e20559ee602987906</inex:ProzessID>
<inex:Zeitstempel>2020-05-11 10:34:42</inex:Zeitstempel>
<inex:StatusID>OK</inex:StatusID>
<inex:Meldung>
<inex:ArtID>Hinweis</inex:ArtID>
<inex:MeldungID>02000</inex:MeldungID>
<inex:Text>Lieferung vorhanden</inex:Text>
</inex:Meldung>
</inex:Status>
<inex:Lieferung>
<inex:ID>4</inex:ID>
<inex:Einstellzeitpunkt>2020-04-29 15:31:37</inex:Einstellzeitpunkt>
<inex:Kategorie>Antrag_Allgemein_Sonstiges</inex:Kategorie>
<inex:KategorieBiPRO>100000000</inex:KategorieBiPRO>
<inex:Transfer>
<inex:ID>435133</inex:ID>
<inex:GeVo>Antrag_Allgemein_Sonstiges</inex:GeVo>
<inex:GeVoBiPRO>100000000</inex:GeVoBiPRO>
<Broker id="/db/ima/Broker/inex-541341.xml" lastChange="2018-12-12 15:16:34" config="inveda/ima/broker/1.1/config.xml" xmlns="">
<Anrede>Firma</Anrede>
<Name>F...</Name>
<Vorname/>
<Strasse>J...</Strasse>
<PLZ>0...</PLZ>
<Ort>L...</Ort>
<Telefon-Privat>0...</Telefon-Privat>
<Fax>0...</Fax>
<Email>v...</Email>
<Vermittlernummern>
<Company id="/db/ima/Supplier/INEX.xml">7...</Company>
</Vermittlernummern>
</Broker>
<Person id="/db/ima/Person/inex-959721.xml" lastChange="2018-12-12 15:16:34" config="inveda/ima/person/1.2/config.xml" xmlns="">
<Anrede>Frau</Anrede>
<Name>K...</Name>
<Vorname>A...</Vorname>
<Strasse>L...</Strasse>
<PLZ>0...</PLZ>
<Ort>L...</Ort>
<Geboren>1...</Geboren>
<References>
<Reference id="/db/ima/Broker/inex-541341.xml" relation="Betreuer"/>
</References>
</Person>
<Contract id="/db/ima/Contract/inex-2342560.xml" lastChange="2018-12-12 15:16:34" config="inveda/ima/contract/1.1/config.xml" type="order" xmlns="">
<VSNR>V...</VSNR>
<Status>vertrag</Status>
<References>
<Reference id="/db/ima/Person/inex-959721.xml" relation="Kunde"/>
<Reference id="/db/ima/Class/inex-19.xml" relation="Sparte"/>
<Reference id="/db/ima/Product/inex-2853.xml" relation="Produkt"/>
<Reference id="/db/ima/Supplier/da-direkt.xml" relation="Anbieter"/>
</References>
</Contract>
<Document id="395" xmlns="">
<Name>P.....pdf</Name>
<Date>2018-10-17T11:55:16</Date>
<Type>pdf</Type>
<Category>Police</Category>
<Compression>NONE</Compression>
<Checksum>
<Method>MD5</Method>
<Value>b75ba339baecba15b8f267b7d6d4a1f6</Value>
</Checksum>
<Size>269844</Size>
<Data xsi:type="base64binary">...</Document>
</inex:Transfer>
...
<inex:ArtDerLieferung>GeVoInitial</inex:ArtDerLieferung>
<inex:Stichtag>2020-04-29T15:31</inex:Stichtag>
<inex:EnthaeltNurDaten>false</inex:EnthaeltNurDaten>
<inex:PeriodischeLieferung>false</inex:PeriodischeLieferung>
<inex:AnzahlTransfers>25</inex:AnzahlTransfers>
</inex:Lieferung>
</inex:Response>
</inex:getShipmentResponse>
</inex:Body>
</inex:Message>
Lieferung bestätigen
Mit dieser Nachricht wird eine Lieferung bestätigt. Dieser wird dann bei ListShipment nicht mehr zurückgegeben.
URL:
https://inex.inveda.net/services/TransferService_1_0_0_0/
Request:
<inex:Message xmlns:inex="http://inex.inveda.net" xmlns="http://inex.inveda.net">
<inex:Header>
<inex:Security>
<inex:SecurityContextToken>
<inex:Identifier>[Token]</inex:Identifier>
</inex:SecurityContextToken>
</inex:Security>
</inex:Header>
<inex:Body>
<inex:acknowledgeShipment>
<inex:Request>
<inex:Version>1.0.0.0</inex:Version>
<inex:ConsumerID>[CONSUMER]</inex:ConsumerID>
<inex:ID>[ID Lieferung]</inex:ID>
</inex:Request>
</inex:acknowledgeShipment>
</inex:Body>
</inex:Message>
Response:
<inex:Message xmlns="http://inex.inveda.net" xmlns:inex="http://inex.inveda.net">
<inex:Header/>
<inex:Body>
<inex:acknowledgeShipmentResponse>
<inex:Response>
<inex:Version>1.0.0.0</inex:Version>
<inex:Status>
<inex:ProzessID>18688415225eb90f783fc7f958582216</inex:ProzessID>
<inex:Zeitstempel>2020-05-11T10:40:25</inex:Zeitstempel>
<inex:StatusID>OK</inex:StatusID>
<inex:Meldung>
<inex:ArtID>Hinweis</inex:ArtID>
<inex:MeldungID>03000</inex:MeldungID>
<inex:Text>Lieferung quittiert</inex:Text>
</inex:Meldung>
</inex:Status>
</inex:Response>
</inex:acknowledgeShipmentResponse>
</inex:Body>
</inex:Message>