How to use
Bulkmail webservice
This content is currently only available in Dutch.
Introductie
Om gebruik van de Bulkmail webservice te kunnen maken dient u een aantal fasen te doorlopen. Deze site beschrijft de procedure, benodigdheden en de instructies.
Als u gebruikt wilt maken van de Bulkmail webservice, neem dan contact op met het team van MijnPost of via mail aan supportb2b@postnl.nl. Het is niet mogelijk via deze website een aanvraag te doen voor toegang tot deze webservice.
Procedure
PostNL zal u vragen op welk (primair) klantnummer u de Bulkmail webservice wilt gebruiken en op welk(e) klantnummer(s) u partijen wilt kunnen voormelden en aanbieden. Op de testomgeving van de Bulkmail webservice wordt voor u een B2B-account aangemaakt. Hiermee kunt u de koppeling gaan testen (Het account krijgt een herkenbare naam opdat in MijnPost duidelijk is dat partijen door een B2B-account zijn aangemaakt).
Het UPN en het primaire klantnummer van het B2B-account worden opgenomen in het certificaat dat moet worden aangemaakt en uitgegeven aan de klant om te kunnen testen op de testomgeving van PostNL.
De volgende gegevens worden aan u gecommuniceerd:
- het certificaat
- het B2B-account
- de WSDL link
- de handleiding Bulkmail webservice
Vervolgens kunt u testen met de Bulkmail webservice. Door PostNL zal een controle worden uitgevoerd op de valide aanlevering van partijen en voormeldingen via de Bulkmail webservice in de testomgeving. Als de testen goed verlopen zijn, dan volgen voor het in productie nemen van uw aansluiting op de Bulkmail webservice dezelfde stappen:
- PostNL zal u vragen op welk (primair) klantnummer u de Bulkmail webservice wilt gebruiken en op welk(e) klantnummer(s) u partijen wilt kunnen voormelden en aanbieden.
- Op de productieomgeving van MijnPost wordt voor u een B2B-account aangemaakt. Hiermee kunt u de koppeling gaan gebruiken (Het account krijgt een herkenbare naam opdat in MijnPost duidelijk is dat partijen door een B2B-account zijn aangemaakt).
- Het UPN en het primaire klantnummer van het B2B-account worden opgenomen in het certificaat dat moet worden aangemaakt en uitgegeven aan de klant om op productie de MijBulkmail webservice te kunnen gaan gebruiken.
- PostNL zal nagaan met welke B2B-variabelen (klantnummers, productnummers, contractnummers en ORIK’s) u kunt werken.
Vervolgens kunt u de Bulkmail webservice gebruiken in productie.
Benodigdheden testomgeving
Onderstaande gegevens zijn nodig om de webservice op de testomgeving aan te roepen en eventueel de orders in MijnPost op te vragen.
Omschrijving | Toelichting |
Certificaat | Het certificaat is een “pfx” bestand. “xxx.pfx”. Deze worden via de mail gecommuniceerd |
WSDL van de testomgeving (a/pat omgeving) | https://b2b-2.mijnpost.pat.postnl.nl/B2BService.svc?wsdl |
URL B2B-webservice | https://b2b-2.mijnpost.pat.postnl.nl/B2BService.svc |
Url MijnPost testomgeving (a/pat omgeving) | https://ppo.waz.mijnpost.pat.postnl.nl |
Inlog account en wachtwoord MijnPost | Deze worden via de mail gecommuniceerd |
Wanneer u en PostNL akkoord zijn dat uw organisatie op de Bulkmail webservice kunt aan sluiten, dan krijgt u het volgende geleverd:
- Gebruikershandleiding van de Bulkmail webservice;
- De WSDL; De url van de webservice op onze testomgeving zal zijn:https://b2b-2.mijnpost.pat.postnl.nl/B2BService.svc. De WSDL is pas op te halen als u een geldig certificaat heeft.
- Een certificaat;
- Een account dat gekoppeld is aan MijnPost, uw klantnummer en het certificaat;
Wat u verder nodig heeft om aan te kunnen sluiten op de Bulkmail webservice:
- U zult uw eigen software (op eigen kosten) zo moeten aanpassen dat u de xml-berichten kunt aanleveren conform de specificaties van PostNL;
- Een tool om het aanbiedformulier wat u in een response bericht krijgt toegestuurd te kunnen openen. Bijvoorbeeld ‘ByteArrayToPdf’.
Type Berichten
PreAdviceBulkMailOrder | Een partij voormelden |
ValidateAdressAttachment | Controleren van een adressenbestand |
GetValdiationResult | Bestanden downloaden tbv ongesorteerde producten |
ValidateAndSortAddressAttachment | Sorteren van een adressenbestand |
GetValidationAndSortingResult | Bestanden downloaden tbv gesorteerde producten |
GetPackagingInformation | EmballageKaarten downloaden |
TenderBulkMailOrder | Een partij aanbieden |
Deze berichten die in de Bulkmail webservice gebruikt worden, staan beschreven in de Message Implemantation Guides (MIG’s):
- “MIG – AddressAttachement”
- "MIG – Bulkmailorder”
- “MIG – PackagingInformation”
Zie tab Documentation.
Voorbeelden Partijen aanbieden
Hieronder een paar voorbeelden van producten die je kunt aanbieden en daarbij de volgorde van de berichten.
Product 1010 (Aangetekende Brief) hoeft niet gecontroleerd of gesorteerd te worden:
Stap 1 – PreAdvicBulkMailOrderV2 (=Voormelden)
Stap 2 – TenderBulkMailOrderV2 (=Aanbieden)
Product 2821( 24uur Gemengd)
Stap 1 - PreAdvicBulkMailOrderV2 (=Voormelden)
Stap 2 – ValidateAddressAttachmentV1 (Controleren van een Adressenbestand)
Stap 3 – GetValidationResultV1 (Bestanden downloaden)
Stap 4 - TenderBulkMailOrderV2 (=Aanbieden)
Product 2835 (Basic Bijzonder, gesorteerd)
Stap 1 - PreAdvicBulkMailOrderV2 (=Voormelden)
Stap 2 – ValidateAndSortAddressAttachmentV1 (Sorteren van een Adressenbestand)
Stap 3 – GetValidationAndSortingResultV1 (Bestanden downloaden)
Stap 4 – TenderBulkMailOrderV2 (=Aanbieden)
Instructies
Bijvoorbeeld partij aanbieden van Product 2835 (Basic Bijzonder, gesorteerd)
Stap 1 - PreAdvicBulkMailOrderV2 (=Voormelden)
Stap 2 – ValidateAndSortAddressAttachmentV1 (Sorteren van een Adressenbestand)
Stap 3 – GetValidationAndSortingResultV1 (Bestanden downloaden)
Stap 4 – TenderBulkMailOrderV2 (=Aanbieden)
Van het product 2835 wordt hieronder uitgelegd hoe je de stappen doorloopt middels de berichten.
Stap 1 – Een partij voormelden met product 2835 Basic Bijzonder, gesorteerd.
Maak een bericht met PreAdvicBulkMailOrderV2.
Zorg ervoor dat je in element ConsignmentShippingDate een geldige datum hebt staan en geef de partij een herkenbare omschrijving.
Dit doe je in het volgende element ORIK-1 (=omschrijving van de partij).
<hum:CharacteristicType>
<hum:CharacteristicName>
<hum:Value>ORIK-1</hum:Value>
</hum:CharacteristicName>
<hum:CharacteristicValue>
<hum:Value>B2B20160512</hum:Value>
</hum:CharacteristicValue>
</hum:CharacteristicType>Stap 2 – Uit het responsebericht (=PreAdviceBulkMailOrderV2Response) van Stap 1 dien je het element Consignmentid 100016843407 (voorbeeld) te kopiëren.
Stap 3 – ga naar het bericht ValidateAndSortAddressAttachmentV1 en plak het Consignmentid 100016843407 als Value bij het element Consignmentid.
Als je zeker bent dat alle Vaues correct zijn ingevuld, klik dan weer op het groene driehoekje. Het adressenbestand wordt nu gesorteerd.
Stap 4 – Ga nu naar het bericht GetValidationAndSortingResultV1 waarmee je de bestanden kunt downloaden. Vul in dit bericht wederom het ConsignmentId 100016843407 en kopieer uit het response bericht (=ValidateAndSortAddressAttachmentV1Response) van Stap 3 de Value die staat bij het element DocumentID de string (zie hieronder het vet gedrukte gedeelte).
Stap 2 – Uit het responsebericht (=PreAdviceBulkMailOrderV2Response) van Stap 1 dien je het element Consignmentid 100016843407 (voorbeeld) te kopiëren.
Stap 3 – ga naar het bericht ValidateAndSortAddressAttachmentV1 en plak het Consignmentid 100016843407 als Value bij het element Consignmentid.
Als je zeker bent dat alle Vaues correct zijn ingevuld, klik dan weer op het groene driehoekje. Het adressenbestand wordt nu gesorteerd.
Stap 4 – Ga nu naar het bericht GetValidationAndSortingResultV1 waarmee je de bestanden kunt downloaden. Vul in dit bericht wederom het ConsignmentId 100016843407 en kopieer uit het response bericht (=ValidateAndSortAddressAttachmentV1Response) van Stap 3 de Value die staat bij het element DocumentID de string (zie hieronder het vet gedrukte gedeelte).
<b:DocumentID>
<b:ID>
<b:Value>d29fc733-367f-4e7d-b1bc-c4764c6542d8</b:Value>
<b:schemeAgencyID i:nil="true"/>
<b:schemeAgencySchemeAgencyID i:nil="true"/>
<b:schemeAgencySchemeID i:nil="true"/>
<b:schemeID i:nil="true"/>
<b:schemeVersionID i:nil="true"/>
</b:ID>
<b:RevisionID i:nil="true"/>
<b:VariationID i:nil="true"/>
<b:agencyRole i:nil="true"/>
</b:DocumentID>Deze string (alleen het vet gedrukte gedeelte hierboven) dien je te plakken als Value bij het element DocumentID (zie schermprint hieronder), en klik weer op het groene driehoekje.
Stap 5 - Als het responsebericht (GetValidationAndSortingResultV1Response) van stap 4 gereed is dan, dan dien je de string te kopiëren die staat bij element EmbeddedData.
Vragen tijdens testen
Vragen over de B2B-webservice tijdens de testfase kunnen gericht worden aan het team van Mijn PostNL via een e-mail aan supportb2b@postnl.nl.