Business API vejledning

Transkript

1 Generelle forholdsregler ved normal installation og installation via silent install samt beskrivelse af de mest almindelige funktioner

2 Indhold Generelt... 3 Ny banknøgle skal installeres efter installation af Business API... 3 Hvad skal installeres?... 3 Tom maskine... 3 Maskinen har allerede IBM MQ installeret... 3 Silent install via commandline... 3 Hvad er en silent install... 3 Action... 4 Sprog... 4 Placering af programfiler... 4 Fravalg af e-safekey... 4 Installlevel (fravalg af IBM MQ Series client)... 5 Eksempler på silent install... 5 Installation af Business API... 5 Standard installation med e-safekey og MQ dansk sprog... 5 e-safekey fravælges MQ installeres dansk sprog... 5 e-safekey og MQ fravælges dansk sprog... 5 Installation af e-safekey... 5 Standard installation af e-safekey... 5 Beskrivelse af de mest almindelige funktioner... 5 Afsendelse af filer... 5 Modtagelse af filer... 6 Kommunikation... 6 Sikkerhed... 7 Oversigt over filtyper til hjemhentning fra banken... 7 Flowdiagrammer... 9 Send fil til banken... 9 Hent filoversigt fra banken Hent fil fra banken Sikkerhedsbrugeroprettelse

3 Generelt Installationen omfatter Business API IBM MQ Series Client og e-safekey (sikkerhedskomponent) Normalt vil alle dele blive installeret på en tom maskine, men i visse tilfælde er det nødvendigt eller ønskeligt at fravælge dele af installationen. I det følgende beskrives mulighederne. Hvis Business PC 5.0 er installeret på maskinen, anbefales det, at kontakte Kundesupport for yderligere instrukser. Kundesupport kan kontaktes på telefonnummer eller via en formular, som kan findes her. Ny banknøgle skal installeres efter installation af Business API Efter installation af Business API, kan det være nødvendigt, at opdatere den offentlige nøgle, ddbpub1.mst, som bliver brugt i forbindelse med kommunikation med banken. Hvis nøglen ikke er blevet opdateret automatisk, er det muligt at gøre dette her. Hvad skal installeres? Tom maskine For dette scenarie gælder at IBM MQ Series Client ikke er installeret e-safekey ikke er installeret I denne situation skal begge dele installeres. Anbefalet (ikke krævet) rækkefølge: 1. e-safekey 2. Business API inkl., IBM MQ Series eller blot 1. Business API inkl., IBM MQ Series og e-safekey. Komponenterne installeres automatisk, når der vælges en normal installation Maskinen har allerede IBM MQ installeret Hvis der findes en IBM MQ på maskinen, skal Kundesupport kontaktes. Der vil i så fald være behov for dannelse af en kanaldefinitionsfil, som håndterer såvel eksisterende applikationer som Business API. Silent install via commandline I det følgende gives en kort introduktion til silent install. Hvad er en silent install I forhold til en almindelig installation sker en silent install helt uden grænseflade. Installationen startes ved (via en commandline/kommandoprompt) at aktivere msiexec.exe med en række parametre. 3

4 Se eksempler senere. Action Den type action der skal udføres, angives som første parameter: /i = Installation /x = afinstallation parameteren efterfølges af den fulde sti til msi-filen. (se eksempel) Sprog Det kan synes unødvendigt at angive sprog, når installationen skal ske silent, men programmet registreres under Tilføj/Fjern programmer, og hvis en bruger efterfølgende ønsker at afinstallere ad denne vej, vil det under installationen valgte sprog blive vist i grænsefladen. Sproget defineres i en såkaldt transform, hvor det gælder at 1030.mst = Dansk 1033.mst = Engelsk 1044.mst = Norsk 1053.mst = Svensk Parameter: Værdi: Eksempel: TRANSFORMS <fuld sti>\<transformpackage> TRANSFORMS = D:\1030.mst Placering af programfiler Som standard placeres programfilerne i følgende programsti: <ProgramFilesFolder>\Danske Bank\Business PC - og det er der normalt ingen grund til at ændre på. Men det kan gøres: Parameter: INSTALLDIR Værdi: fuld sti Eksempel: INSTALLDIR= E:\Eksterne programmer\banker\danske Bank\BPC Fravalg af e-safekey Hvis e-safekey installeres som en del af Business API installationen, sker det i form af en "nested install", med ARPSYSTEMCOMPONENT=1, hvilket betyder at e-safekey ikke fremtræder i "Tilføj/Fjern programmer". Hvis man i stedet ønsker at installere e-safekey selvstændigt kan dette ske på normal vis via et separat installationssetup. Hvis dette sker før installationen af Business API, behøver man ikke foretage sig noget, men hvis Business API installeres først (eller rækkefølgen kan være vilkårlig) skal installationen af e-safekey fravælges. Det sker ved at sætte parameteren SKIP_ESAFEKEY: Parameter: Værdier: Eksempel: Bemærk: SKIP_ESAFEKEY 0 (Default) e-safekey installeres hvis nødvendigt og muligt 1 e-safekey installeres ikke SKIP_ESAFEKEY=1 Hvis e-safekey tidligere er installeret via et selvstændigt setup, skal programmet afinstalleres inden installationen af den nye version kan gennemføres. 4

5 Installlevel (fravalg af IBM MQ Series client) Brugen af Business API kræver at der er IBM MQ installeret på maskinen. Hvis der ikke i forvejen er installeret en MQ client på maskinen behøver man ikke angive noget den vil blive installeret da default installlevel er 100. Hvis der i forvejen er en MQ client installeret bør INSTALLLEVEL angives til en værdi i intervallet 2 99, hvilket vil bevirke at MQ ikke installeres, da Installlevel for de to features i installationen er sat som vist nedenfor: Feature Installlevel BPC_API_Main 1 MQ_Client 100 Se under "Eksempler" hvordan parameteren angives. TIP: Bemærk at en typisk fejl vil være at angive INSTALLEVEL, det skal være INSTALLLEVEL. Eksempler på silent install I de følgende eksempler på silent installation (parameteren "/q") antages at installationsfilerne findes på maskinens drev D: Hvis parameteren "/q" udelades, vil brugergrænsefladen blive vist på sædvanlig vis. Installation af Business API Standard installation med e-safekey og MQ dansk sprog msiexec /i "D:\Business PC 5.0 API.msi" TRANSFORMS="D:\1030.mst" /q e-safekey fravælges MQ installeres dansk sprog msiexec /i "D:\Business PC 5.0 API.msi" TRANSFORMS="D:\1030.mst" SKIP_ESAFEKEY=1 /q e-safekey og MQ fravælges dansk sprog msiexec /i "D:\Business PC 5.0 API.msi" TRANSFORMS="D:\1030.mst" INSTALLLEVEL=50 SKIP_ESAFEKEY=1 /q Installation af e-safekey Installationen af e-safekey er altid med engelsk brugergrænseflade, hvorfor der ikke skal angives TRANSFORMS. Standard installation af e-safekey msiexec /i "D:\e-Safekey.msi" /q Beskrivelse af de mest almindelige funktioner Afsendelse af filer Funktionen SendFile method (SecureExchange) benyttes, når der skal sendes filer til banken. Ved afsendelse af filer til banken via Business API'et, får man en hostreference retur. Når man får denne fil retur, ved man at banken har modtaget forsendelsen. Om formatet og indholdet i filen er korrekt betyder ikke noget i forhold til Business API'et, da dets opgave alene er afsendelse/modtagelse af filer. Hostreferencen er altså ikke en accept af, at indholdet af filen kunne læses af banken, men derimod, at banken har modtaget en fil og at filafsendelsensproceduren er blevet udført korrekt. På nuværende 5

6 tidspunkt kan man se status på filen via vores webgrænseflade, Business Online eller ved at modtage en betalingsstatusfil via funktionen SendFileRequest metoden beskrevet forneden. Statusfilen kan i mange tilfælde bestilles direkte i betalingsfilen. Kontakt Kundesupport for yderligere oplysninger. Modtagelse af filer Modtagelse af filer via Business API'et sker ved hjælp af SendFileRequest method (SecureExchange). (Se hjælpefilen BPCAPI.chm). Ved hjælp af metoden SendFileSurveyRequest method (SecureExchange), får man præsenteret indholdet af sin mailboks i banken. Ved hjælp af parametrene "CreationTime" og "RequestId" kan man hente den ønskede fil. De to parametre mm. præsenteres i oversigtsfilen (FileSurvey) over indholdet i kundens mailboks. FileSurvey filen er en semi-xml fil og er opbygget af: - type: max 8 karakter, alfanumerisk - beskrivelse: max 36 karakter, alfanumerisk - fritekst: max 180 karakter, alfanumerisk - BENYTTES IKKE - tidspunkt hvor filen er genereret: 10 karakter f.eks (ååmmddttmm) - format: max 20 karakter, alfanumerisk - tidligere modtaget: 1 karakter J/N - størrelse: (beregnet) op til bestillingsnummer eller leverancenummer: max 10 karakter, alfanumerisk - forsendelsesnummer: max 10 karakter ER ALTID XXXXXXXXXX Filoversigten kan se sådan ud, hvor der ligger en indbetalingsfil klar til hjemhentning ved navn hrch 5: <Type>KRE</Type> <Description>hrch 5</Description> <Text /> <CreationTime> </CreationTime> <Format /> <ReceivedBefore>N</ReceivedBefore> <SizeInBytes> </SizeInBytes> <RequestID> </RequestID> <DeliveryNumber>XXXXXXXXXX</DeliveryNumber> På side 9 fremgår alle typebetegnelserne (<Type>) og deres indhold. Kommunikation Business API'et anvender IBM Message Queing (IBM MQ) til at overføre af alle data mellem banken og virksomheden. Kommunikationsmodulet kommunikerer via port 1414, så denne port skal være åben i udgående retning. Kommunikationsprogrammet (IBM Message Queing) foretager et navnekald til mq.businessedi.biz på port Returporten tildeles dynamisk. Hvis der allerede sendes eller hentes filer via bankens officebanking system, Business Online, er port 1414 allerede åben. Vær opmærksom på, at findes der en IBM MQ client på maskinen i forvejen, vil API installationen advare om dette. Man bør ikke installere MQ, hvis der ligger en version i forvejen. Kontakt Kundesupport, hvis dette problem opleves under installationen af Business API'et. Hvis API'et installeres på en pc med Windows NT 4.0, Windows 2000 eller Windows XP, Windows server 2003, og den pågældende pc er logget på virksomhedens domæne (hvis et sådant findes), skal 6

7 der oprettes en særlig brugergruppe for at MQ kan fungere korrekt. Oprettelsen skal foretages på virksomhedens domæne-controller og brugergruppe (local group) kaldes mqm (navnet skal stå med små bogstaver). Det er ikke nødvendigt at tilknytte brugere til gruppen. Gruppen skal blot være oprettet med det korrekte navn som lokalgruppe. Hvis gruppen ikke findes, vil Business API'et ikke kunne kommunikere med banken, uanset om kommunikationen foregår direkte til banken via modem/router eller via Internettet. API-installationsprogrammet opretter gruppen lokalt på pc'en (AddLocalGroup.dll), så medmindre pc'en indgår i et domæne, er det ikke nødvendigt at foretage sig yderligere. Sikkerhed Business API'et benytter sikkerhedsløsningen e-safekey, som bygger på anvendelse af en offentlig nøgle og en privat nøgle. Der kan anvendes personlige eller tekniske brugere, når der skal kommunikeres med banken via Business API. Læs mere her. Business API et er først klar til brug, når Business API-brugeren er oprettet. For at oprette en Business API-bruger skal man anvende bankens nøgleoprettelsesside. Her er det også muligt at genåbne adgangen til Business API et i tilfælde af spærring og forny brugerens private nøgle. Læs mere om disse muligheder under Kom godt i gang sektionen på Business API hjemmesiden: 2.danskebank.dk/api. Placeringen af nøglerne, efter at de er oprettet, kan findes her: Sti til offentlig nøgle: HKEY_LOCAL_MACHINE\SOFTWARE\e-SafeKey Sti til brugerens nøgle: HKEY_LOCAL_MACHINE\SOFTWARE\e-SafeKey\Business Oversigt over filtyper til hjemhentning fra banken Filtype Meddelelser fra banken Gennemførte debiteringer Gennemførte krediteringer Posteringsoversigt Posteringer til udkrydsning Saldo på indenlandske konti Saldo valutakonti./konti. i udenl. bank Fælles indbetalingskort Kontoudskrift Telepay - gennemførte betalinger (Avregningsretur) Termins engagement Værdipapir depot beholdning. Valutakurser Valuta krydskurser Valuta rentesatser MultiCurrency Interest Netting Kontoafstemning Udenlandske notaer(overførsel til udland) Udenlandske notaer(overførsel fra udland) IMG-Image <Type> MFB DEB KRE PTO PTX SLI SLU FIK FIN TLP TRM VPD VKS VKK VRS IMN KAF OTU OFU IMG 7

8 Customer Account Posting Incitamentsprogram Indbetalinger IK-BS Indbetalinger med bilag Indbetalinger Interessekontor Checkdebiteringsliste Ekspeditionsliste konto-konto Ekspeditionsliste check Ekspeditionsliste løn Liste over udstedte checks Kundenummeroplysning BBS retur-fil Telepay førstegangsretur (mottaksretur) OCR fra Bankgirot LM fra Bankgirot GI fra Bankgirot AutoGiro fra Bankgirot E-Giro fra Bankgirot AutoGiro medgivanda advisering E-Giro E-Medgivanda Advis LB fra Bankgirot OCR-fil Norge TIPS fra Bankgirot E-faktura fra Bankgirot E-Giro AutoGiro E-Giro medgivanda advisering E-Giro redovisning E-Giro business to business E-Giro E-Faktura Image filer fra Bankgirot Mappe feedback e faktura DK e faktura DK Kvittering CAP INC IBK IKB IKO CHD KTO CHK LØN CUD KNR BBS TR1 OC LM GI AG AG LB OCN TIPS BIL FFE IIN IRC 8

9 Flowdiagrammer Send fil til banken SendFile Customer Danske Bank Init Logon SecureExchange SendFile method Host Event SendSucceed Event SendError Logoff Hostreference 9

10 Hent filoversigt fra banken FileSurvey Customer Danske Bank Init Logon SecureExchange SendFileSurvey Request Host Event Request- SurveySucceed Event Request- SurveyError Logoff Filesurvey 10

11 Hent fil fra banken FileRequest Customer Danske Bank Init Logon SecureExchange SendFile Request Host Event RequestFile Succeed Event RequestFile Error Logoff Requested file 11

12 Sikkerhedsbrugeroprettelse CreateKey key Customer Danske Bank Init SecureExchange AdministrationCreateKey Createkey message Acknowledgement Host 12