WEB SERVICE GRÄNSSNITT SAMLINKS TEKNISKA GRÄNSSNITTSBESKRIVNING FÖR PROGRAMVARUHUS

Transkript

1 WEB SERVICE GRÄNSSNITT

2 Innehållsförteckning 2 (13) Innehållsförteckning 1 SOAP-ram Packning av betalningsmaterial Kryptering av betalningsmaterial Stödda operationer Application Request Header SenderId RequestId Timestamp Language UserAgent ReceiverId Använda element i Application Request meddelandet CustomerId Command Timestamp StartDate EndDate Status ServiceId Environment FileReferences/FileReference UserFileName TargetId ExecutionSerial Encryption EncryptionMethod Compression CompressionMethod AmountTotal TransactionCount SoftwareId CustomerExtension FileType Content Signature Application Responses element CustomerId Timestamp ResponseCode... 7

3 Innehållsförteckning 3 (13) ResponseText ExecutionSerial Encrypted EncryptionMethod Compressed CompressionMethod AmountTotal TransactionCount CustomerExtension FileDescriptors FileDescriptor UserFileTypes Content Signature Exempelmeddelanden SOAP-förfrågan (uploadfile) Application Request UploadFile Application Request DownloadFileList Application Request DownloadFile... 13

4 4 (13) 1 SOAP-ram Vi tar emot SEPA-material i WS-kanalen endast i SOAP-meddelanden. I SOAP-meddelandets rubrik ska det finnas signatur i elementet WS-Security. 2 Packning av betalningsmaterial Samlinks systemlösning stöder packning av material i enlighet med RFC Värdet i fältet CompressionMethod är då GZIP och i elementet Compression true. 3 Kryptering av betalningsmaterial Separat kryptering av betalningsmaterial stöds inte (elementen EncryptionMethod och Encryption). 4 Stödda operationer Stödda uploadfile downloadfilelist downloadfile deletefile Inte stödda getuserinfo o returnerar felkoden 05, (getuserinfo not supported) 5 Application Request Header I Application Request finns element vars användning preciseras nedan. 5.1 SenderId Avsändarens unika identifikationskod d.v.s. WS-användarkoden. Den överläts till före-taget när avtalet undertecknades. 5.2 RequestId Försändelsens unika identifikationskod. Material som kommer under samma dygn ska ha ett unikt värde. Om värdet har använts tidigare förkastas meddelandet som duplikat. 5.3 Timestamp Tidsstämpel som anger när Application Request Header har skapats. 5.4 Language Finska: FI Svenska: SV

5 5 (13) Engelska: EN 5.5 UserAgent 5.6 ReceiverId Inte i användning 6 Använda element i Application Request meddelandet 6.1 CustomerId Unik identifkationskod d.v.s. servicekod för den som bildar materialet. Den överläts till företaget när avtalet undertecknades. 6.2 Command Värdet ska motsvara SOAP-operationen. 6.3 Timestamp Tidsstämpel som anger när Application Request har skapats 6.4 StartDate Vi läser elementets värde endast för operationerna: DownloadFileList. 6.5 EndDate Vi läser elementets värde endast för operationerna: DownloadFileList. 6.6 Status Vi läser elementets värde endast för operationerna: DownloadFileList. Vi stöder koderna NEW, DLD, ALL. 6.7 ServiceId Inte i användning 6.8 Environment Vi stöder: PRODUCTION och TEST I testmiljön används produktionens koder men materialen går inte till betalning.

6 6 (13) 6.9 FileReferences/FileReference Vi läser elementets värde endast för operationerna: DownloadFile och DeleteFile. Endast för returdata. Max 50 Filereference-element i ett meddelade tillåtet UserFileName Vi läser elementets värde endast för operationerna: UploadFile 6.11 TargetId Stöds i enlighet med definitionen ExecutionSerial Inte i användning Encryption Inte i användning EncryptionMethod Inte i användning Compression Stöds, värdet antingen true eller false CompressionMethod Om den används är värdet GZIP 6.17 AmountTotal Vi läser elementets värde endast för operationerna: UploadFile. Om elementet finns och om FileType är XL, jämför vi fältets värde med betalningsmaterialets summa. Om FileType är XL, återställer vi i response rätt värde i det här fältet, fast-än client inte skulle ha räknat det TransactionCount Vi läser elementets värde endast för operationerna: UploadFile. För betalningsmaterialet XL jämför vi värdet i det här elementet med be-talningsmaterialets summa. Om betalningsmaterialet är XL, återställer vi i response det rätta värdet i det här fältet, fastän kundens tillämpning inte skulle ha räknat det.

7 7 (13) 6.19 SoftwareId Uppgift om programvaran och dess version som kundens tillämpning skickat CustomerExtension Inte i användning FileType Vi läser elementets värde endast för operationerna: UploadFile, DownloadFile och DownloadFile- List. Lista på stödda materialtyper i tjänstebeskrivningen för Web Services-förbindelsen Content Vi läser elementets värde endast för operationerna: UploadFile 6.23 Signature Alla meddelanden ska vara signerade. 7 Application Responses element 7.1 CustomerId Kundens servicekod. 7.2 Timestamp Tidsstämpel utgående från vilken man kan konstatera att ett material har gått ut. (Vid genomförandeskedet utreds vilket värde som är lämpligt). 7.3 ResponseCode Kod Förklaring 00 OK 05 OKÄND TILLÄMPNINGSFÖRFRÅGAN 12 DEN FORMELLA GRANSKNINGEN AV MATERIALET MISSLYCKADES 21 PACNINGEN AV MATERIALET FELAKTIG 25 MATERIALET INTE TILLÅTET 26 TEKNISKT FEL 27 MATERIALET KAN INTE TAS BORT 30 IDENTIFIERINGEN MISSLYCKADES 32 DUBBELFÖRSÄNDELSE

8 8 (13) 7.4 ResponseText Se ovan 7.5 ExecutionSerial Används inte 7.6 Encrypted Används inte 7.7 EncryptionMethod Används inte 7.8 Compressed Vi stöder packande i enlighet med definitionen 7.9 CompressionMethod Vi stöder i enlighet med RFC AmountTotal Se förklaringen av request 7.11 TransactionCount Se förklaringen av request 7.12 CustomerExtension Inte i användning 7.13 FileDescriptors Vi returnerar elementet endast: DownloadFileList FileDescriptor Vi returnerar elementet endast: DownloadFileList FileReference (alltid) TargetId (alltid) ServiceId (används inte) ServiceIdOwnerName (används inte) UserFileName (alltid) ParentFileReference (om det är fråga om returdata)

9 9 (13) FileType (alltid) FileTimestamp (alltid) Status (alltid) AmountTotal (alltid) TransactionCount (alltid) LastDownloadTimestamp (ges returdata om inte tom) ForwardedTimestamp (återges materialet om inte tom) Confirmable (används inte) Deletable (används inte) SubStatusCode (används inte) SubStatusText (används inte) MissingTransactions (används inte) SubType (används inte) FeedbackFileAttributes (används inte) 7.14 UserFileTypes Vi stöder inte GetUserInfo-operationen och återsänder därmed inte UserFileTypes-elementet Content Vi återsänder elementet endast: DownloadFile Om man i kundsökningen ber om flera filer finns filernas innehåll efter varandra i Con-tent Signature Vi signerar alla svar

10 10 (13) 8 Exempelmeddelanden 8.1 SOAP-förfrågan (uploadfile)

11 11 (13) 8.2 Application Request UploadFile

12 12 (13) 8.3 Application Request DownloadFileList

13 13 (13) 8.4 Application Request DownloadFile