Batch-grensesnitt for masseutsendelser
Dette er en en overordnet guide for hvordan du kan integrere mot Digipost sitt batch-grensesnitt for avsendere. For detaljert grensesnittsbeskrivelse se batch startpakken.
Batch-grensesnittet egner seg bra når du skal sende mange brev om gangen. Bruk av dette grensesnittet går ut på å laste opp en jobbfil til Digipost. Alle brevene som lastes opp i én jobb hvor vi klarer å identifisere mottakeren, vil leveres samtidig eller ikke i det hele tatt (atomisk operasjon).
1. Beskrivelse av batch-grensesnittet
Batch-grensesnittet støtter for øyeblikket to operasjoner:
«mottakersplitt» – benyttes til å identifisere Digipost-brukere uten å sende brev. Du sender inn en liste med postmottakere som vi forsøker å identifisere. For de personene som er Digipost-brukere, returnerer vi personenes Digipost-adresser som kan brukes til brevsending. For de personene vi klarer å identifisere, men ikke er Digipost-brukere, returnerer vi et person-alias, som du kan bruke til å identifisere mottakeren overfor Digipost ved senere mottakersplitter. Hvis vedkommende senere oppretter konto hos Digipost, vil du i neste mottakersplitt få Digipost-adressen tilbake, og du kan begynne å sende vedkommende brev.
«masseutsendelse» – benyttes til å sende brev til Digipost-brukere. Dette går ut på at man sender inn en liste av postmottakere og tilhørende dokumenter som skal distribueres. Som svar får man først en mottakskvittering som bekrefter at jobb-fil er mottatt i korrekt format, deretter en ny kvittering med selve resultatet på utsendelsen når masseutsendelsen er ferdigprosessert.
Det er i hovedsak tre ulike varianter av hvordan en virksomhet kan benytte seg av disse to tjenestene. Som en del av planleggingen for integrasjonen med Digipost bør du ta stilling til hvilket mønster som passer best for din virksomhet. Du står også fritt til å lage din variant: med/uten oppdatering av eget register, med/uten jevnlig adressevask, etc.
2. Mottakersplitt før hver masseutsendelse
Dette mønstret garanterer at man i enhver brevutsendelse når flest mulig Digipost-brukere, inkludert de som nylig er registrert. Det er også effektivt når det gjelder båndbredde og prosesseringstid. Bruken av dette går ut på at man alltid gjør en mottakersplitt i forkant av en masseutsendelse. Mottakersplitten trenger bare å omfatte de postmottakerne som er inkludert i den aktuelle postutsendelsen. Dette mønstret egner seg bra for virksomheter som sender sjeldnere enn én gang i uken.
Gitt at en batch med brev er klar for utsending, lag og send en mottakersplitt-jobb til Digipost for de personene du skal sende brev til. Motta mottakersplitt-kvittering fra Digipost, med Digipost-adresse for hver identifiserte Digipost-bruker og person-alias for øvrige personer vi lykkes i å identifisere.
Gitt identifiserte Digipost-brukere og tilhørende brev, lag og send masseutsendelse-jobb til Digipost. Motta masseutsendelse-kvittering fra Digipost, logg resultatet og håndter eventuelle avvik.
3. Regelmessig mottakersplitt uavhengig av masseutsendelse
Dette mønstret går ut på at man regelmessig oppdaterer sitt eget mottakerregister med Digipost-adressene og person-aliasene til de av ens mottakere. Dette mønstret passer bra dersom virksomheten foretar hyppige brevutsendelser (én gang i uken eller oftere).
- Send regelmessig (f.eks. ukentlig) en mottakersplitt-jobb til Digipost for hele mottakerregisteret og oppdater ditt eget register med Digipost-adressene og person-aliasene du får tilbake.
- For brevutsendelser, identifiser Digipost-brukerne i et eget register. Lag og send en masseutsendelse-jobb til Digipost for disse mottakerne. Motta masseutsendelse-kvittering fra Digipost, logg resultatene og håndter eventuelle avvik.
Dette mønstret kan være fordelaktig dersom man bruker navn og adresse for mottaker-identifikasjon. Masseutsendelse-operasjonen tar ikke lang tid å utføre når du identifiserer mottakere med Digipost-adresse. En mottakersplitt-jobb på navn og adresse kan ta forholdsvis lang tid å prosessere (potensielt flere timer, avhengig av jobb-størrelse). Dette vil kortes betraktelig ned dersom man passer på å bruke person-alias for de av mottakerne som tidligere er blitt identifisert.
Regelmessig mottakersplitt (på person-alias for identifiserte brukere og navn og adresse for øvrige) kan også brukes i kombinasjon med sending via Digipost APIet: Du oppdaterer jevnlig ditt eget kunderegister med mottakernes Digipost-adresser og person-alias via mottakersplitt-jobber, for å kunne sende fortløpende via Digipost APIet. Dette vil gjøre at du får bedre treffprosent enn når du bruker Digipost APIet alene.
4. Kun masseutsendelse
I denne varianten sender man alltid inn alle mottakere og tilhørende brev til Digipost, uten å vite om disse mottakerne er Digipost-brukere eller ikke. Digipost vil sende brevene til de personene som er Digipost-brukere og forkaste resten.
Resultat kvitteringsfilen forteller deg hvilke mottakere som var Digipost-brukere og mottok brevet. Du må deretter sende brevene til de resterende personene via en alternativ kanal. Dette kan for enkelte virksomheter være den enkleste varianten å implementere, men vil som regel kreve betraktelig mer båndbredde og lengre leveringstid.
Dette alternativet egner seg best ved mindre utsendelser (færre enn 1000 brev) og mindre brevstørrelser (maksimalt 150 kB).
- Lag og send en masseutsendelse-jobb til Digipost for alle mottakere.
- Motta masseutsendelse-kvittering fra Digipost, identifiser mottakerne som ikke fikk noe brev tilsendt via Digipost og kontakt disse via en alternativ kanal (vanligvis fysisk post).
Vi anbefaler at du benytter variant 1a) eller 1b) dersom det er mulig, siden disse som regel gir best ytelse.
5. Masseutsendelse med brev til fysisk utskrift
Denne varianten bygger på "Kun masseutsendelse" alternativet ved å sende fysisk post til de mottakerne som ikke har Digipost-konto. Fysisk postadresse på mottaker og avsenders returpostadresse inkluderes på alle brev som defineres i masseutsendelse-jobben. Massutsendelse-kvittering vil fortelle deg om brevet ble levert digitalt eller vil bli levert som fysisk post.
Eksempler på hvordan fysisk post er strukturert i masseutsendelse-jobber er inkludert i batch startpakken. Du bør lese detaljer tilknyttet fysisk print med Digipost før du velger dette alternativet.
