End User Manual
Contents
1. 4 2 5 Error Status code Reason phrase Corrective action 400 range Client error The request contains bad syntax or cannot be fulfilled An overview of HTTP error codes can be found in http www rfc editor org ric rfc261 6 txt 500 range Server error The server failed to fulfil request Please try again later and if oroblem persists contact 4 3 Request list of available feedback 4 3 1 Description The service requestFeedbackList is used to request the list of feedback identifiers available Only the identifier of the feedback associated with a file sent with this user will be sent back The feedback associated with files sent by another user but for a common declarer will not be sent back You can choose between requesting a list of either new feedbacks or feedbacks associated to files sent during a specified time frame The second option offers you the possibility to request feedbacks that have been retrieved earlier 4 3 2 URL Test https onegate a2a test nbb be crs esb invoke requestFeedbackList v2 0 Production _ httpsi onegate a2a nbb be crs esb invoke requestFeedbackList v2 0 These are general URLs for OneGate Each Business Domain has his one s own URL Please consult the URL document for the desired Institute Business Domain 4 3 3 HTTPS Request 4 3 3 1 Body The request of the feedback list must be fulfill the XML format described below OneGate CSSR End User Manual crs HotRead Request onlw2. Found FeedbackLiztResponse List of identifier of the Feedback available for the requested parameters crs Feedback TT T G List of message identifier L PE associated ta a CRS document send by this user FeedbackListResponse Description Contains the list of the available feedback identifiers XML format ComplexType Children NoFeedback Feedback NoFeedback Description No feedback found for the specified search criteria e Not read no new feedback e Read no feedback during the specified time frame XML format ComplexType Validation Empty element Feedback Description Contains the information about the feedback available for download XML format ComplexType Minimum occurence 1 Maximum occurence unbounded Children Feedbackld Ticketld Feedbackld XML format xs nonNegativelnteger minExclusive 0 Validation Required OneGate CSSR End User Manual TicketID Description Identifier of the file transfer to whom the feedback is associated XML format xs string Validation Required 4 3 5 Error Status code Reason phrase Corrective action The service feedoackRequest is used to request a specific feedback by providing its identifier The format of the feedback must follow the business requirement in terms of format and security level applied 4 4 Request a feedback 4 4 1 Description If the business requires that you send your file signed and or encrypted the
3. Global Sign Certipost and Isabel If you never used your certificate to access one of the NBB applications you need to register your certificate If you try to consume one of the HTTPS entrypoints without having registered your certificate before you will receive an HTTPS 401 error code You can find more information about the certificate policy and registration in the OneGate CSSR End user manual Ref 1 and about the NBB certificates in the referred documents 5 to 8 3 3 Authorization When your certificate is registered at the NBB you must request access with this certificate to the application OneGate CSSR The authorization process is based on security role To request the role that will give you access to the application OneGate CSSR you need to follow the procedure described in document 1 Once the authority approved your access request you will be able to use your certificate to automate the data exchange and have access to the online application OneGate CSSR End User Manual If you try to consume one of the HTTPS Entrypoints without having requested access before you will receive an HTTPS 403 error code 3 4 Secure data The communication protocol between the client and OneGate is always HTTPS which guarantuees confidentiality of the data exchange However for some business domains additional security measures can be taken OneGate CSSR supports the exchange of secure data By secure we mean signed data or
4. URL http Awww microsoft com downloads details aspx FamilyID 9B2DA534 3E03 4391 8A4D 074B9F2BC1BF amp displaylang en To convert a PFX file to a PEM file follow these steps on a Windows machine 1 Download and install the Win32 OpenSSL Win32 OpenSSL v0 9 8i package from http www slproweb com products Win320penSSL html 2 Create a folder c certs and copy the file yourcert pfx into the c certs folder 3 Open a command prompt and change into the OpenSSL bin directory cd homedrive OpenSSL bin 4 Type the following command to convert the PFX file to an unencrypted PEM file all on one line openssl pkcs12 in c certs yourcert pfx out c certs cag pem nodes 5 When prompted for the import password enter the password you used when exporting the certificate to a PFX file You should receive a message that says MAC verified OK Command Prompt CS 5c 0 homedrivex gt Open l bin HEM 61T BS KTR H pkesi2 in TTT eT a 2 pfx out KTT a cT TT nodes Enter Import Password MAG verified OK CS Open L hbin _ 6 You can find the converted certificate in the specified location c certs cag pem 9 Procedure described by Citrix in the following article http support citrix com article CTX106028 2 OneGate CSSR End User Manual 6 1 2 Server certificate Certificates Intended purpose lt All gt Intermediate Certification Authorities Trusted Root Certification Authorities Trusted Publ Ce
5. feedback will follow the same requirement and will be signed and or encrypted 44 2 URL Test https onegate a2a test nbb be crs esb invoke requestFeedback v2 0 Production httpsi onegate a2a nbb be crs esb invoke requesiFeedback v2 0 These are general URLs for OneGate Each Business Domain has his proper own URL Please consult the URL document for the desired Institute Business Domain 44 3 HTTPS Request 4 4 3 1 Body The request of a specific feedback must be fulfill the XML format described below FeedbackRegquest l ee E crs Feedbackld Request a specific Feedback Identifier of the requested edback OneGate CSSR End User Manual FeedbackRequest Description Contains the information about the requested feedback XML format ComplexType Children Feedbackld Feedbackld Description Identifier of the requested feedback XML format xs nonNegativelnteger minExclusive 0 Validation Required 4 4 3 2 Header No specific header 4 4 4 HTTPS Response If OneGate CSSR has successfully processed the request the response returns a status code 200 and the feedback in the XML format described below 2 E N T a ae el FeedbackResponse L crs Attachment FeedbackResponse Message Description The message is the feedback which contains at least one body XML format ComplexType Children Body Attachment 5 Max value 2 63 1 9223372036854775807 OneGate CSSR End User Manual
6. max size specified in Volume Omer status cede Pease consult hiipiwwwroedtocorgifaite2o1eut E 7 ie detail 5 2 Server error If the server cannot process your request due to a technical problem the response returns a status code 500 or in and a reason phrase given an indication of the problem occurred on the server side In this case please retry to send your request and if the problem persists please contact the NBB IT Servicedesk 32 2 221 40 60 servicedesk nbb be 26 OneGate CSSR End User Manual 6 Appendix Sample using cURL 6 1 Prerequisites 6 1 1 Client certificate CURL uses only the pem certificate file format So if your certificate has not a pem extension you need to convert your certificate to a pem How to convert certificate pfx to pem If you have requested and installed a certificate onto a Windows server using the Internet Information Service IIS certificate wizard you can export that certificate with its private key to a Personal Information Exchange PFX file To import this certificate onto the Access Gateway you must convert the PFX file to the unencrypted PEM format You may use the open source utility OpenSSL to perform the conversion from PFX to PEM You can download a Wins2 distribution of OpenSSL here http www slproweb com products Win320penSSL html You might also need C re distributable files if you want to use OpenSSL which can be obtained at the following
7. www onegate eu 2010 09 01 esb gt lt crs FeedbackId gt 60163 lt crs FeedbackId gt lt crs FeedbackRequest gt 6 2 4 3 HTTPS Response lt ml versl on OT lt crs FeedbackResponse xmlns crs http www onegate eu 2010 09 01 esb gt lt esb Message gt e bD Body Next recdback for TICFET ID 2 gt PERORTIREFERENC ETTET sAFE457e8sd4 STEP 3 lt esb Body gt lt esb Attachment contentType text xml URL https someurl be dummy 142254 gt lt esb Attachment contentType text xml URL https someurl be dummy 128564 gt lt esb Message gt lt crs FeedbackResponse gt 6 2 5 GET attachment for feedback 6 2 5 1 Command cURL curl y L b cookies post302 E lt cerCiiicate pem password o https someurl be dummy 142254 6 2 5 2 HTTPS Request Sample of the HTTPS url 6 2 5 3 HTTPS Response The xml file 31 OneGate CSSR End User Manual 7 Definition of terms and abbreviations Abbreviation Description A2A Application to Application refers to the interaction between two applications Acknowledgment of file receipt This acknowledgment of file receipt indicates that a file was received that the file transfer is recorded under a identification number Tickeld This acknowledgment does not contain any information about the validity of the document Feedback OneGate CSSR Feedback OneGate is the validation report generated automatically by OneGate CSSR when the sending file is processed The
8. 2 3 HTTPS Response lt xml version 1 0 lt crs UploadFileResponse xmins crs http www onegate eu 2010 09 01 esb gt Crs WiCker ID 6324 Cue buckeelubD gt lt crs UploadFileResponse gt 6 2 3 Request list of feedback 6 2 3 1 Command cURL cur T L b cookies post302 Ho Core WhllCabe pem password T data binary requestFeedbackList xml ae MMC IOS amp onegate a2a nbb be crs esb invoke request FeedbackList v2 0 6 2 3 2 HTTPS Request Sample of requestFeedbackList xml lt lt ey I lt crs FeedbackListRequest xmlns crs http www onegate eu 2010 09 01 esb gt lt crs NotRead gt lt crs FeedbackListRequest gt 6 2 3 3 HTTPS Response lt xml Vers 1om 1 0 23 gt lt crs FeedbackListResponse xmlns crs http www onegate eu 2010 09 01 esb gt lt crs Feedback gt lt crs FeedbackId gt 60163 lt crs FeedbackId gt etc Mieke tid 490 65 lie Kemilee lt ers Feedback gt lt crs Feedback gt lt crs FeedbackId gt 60168 lt crs FeedbackId gt K D IE I9 L N L lt crs Feedback gt lt crs FeedbackListResponse gt 30 OneGate CSSR End User Manual 6 2 4 Request feedback 6 2 4 1 Command cURL eoue S L b cookies post302 E Cor tit le E RH a dea sol Manny requestFeedback xml https onegate a2a nbb be crs esb invoke requestFeedback v2 0 6 2 4 2 HTTPS Request Sample of requestFeedback xml myer on E LO eS lt crs FeedbackRequest xmlns crs http
9. Body Description Body of the message in plain text Example Validation report for ticket number 480 XML format xs string Validation Attachment Description Attachment of the message XML format text xml minOccurs 0 maxOccurs unbounded Attributes Type ss contentType xsstring text xml xs string Validation Optional 4 4 5 Error message Status code Reason phrase Corrective action OneGate CSSR End User Manual 45 GET an attachment of a feedback 4 5 1 Description Each attachment of a feedbackResponse should be retrieved by its unique url HTTPS GET This implies that a A2A authenticated user that has access to the HTTP entrypoints will also have the ability to get access to the requested URL The application will verify that the A2A user has the authority to access the specified URL This is done to prevent a participant from accessing data of another participant 4 5 2 URL Test URL found in the FeedbackResponse Production URL found in the FeedbackResponse 4 5 3 HTTPS Request 4 5 4 Error message Status code Reason phrase Corrective action 46 2 URL Test https onegate a2a test nbb be crs esb invoke requesiMessageList v2 0 Production _https onegate a2a nbb be ors esb invoke requestMessageList v2 0 OneGate CSSR End User Manual These are general URLs for OneGate Each Business Domain has his one s own URL Please consult the URL document for the desired Institute Busines
10. For assistance on filling the meta data fields of this document just activate the Show Hide 4 PSD Project code Department Group Author Date Version Status Authorized by Reviewers Commentators Approvers Location function OneGate CSSR HTTPS Entrypoints CRS CRS PRSM PRSM PRSM DQ PRSM DQDQ External partners Cellule Research and Development DQ http teamn prd nbb sites CRS Shared End User Manual Documents DQ07CSSRINT User s manuals External OneGate CSSR End User Manual HTTPS entrypoints docx N Nationale DE BELGIQUE Abstract This document template is to be used for writing the End User Manual for a developed business service or product It forms part of the System Development Life Cycle SDLC There are separate user manuals for operatos administrators and for developers of the service National Bank of Belgium Brussels All rights reserved Reproduction for educational and non commercial purposes is permitted provided that the source is acknowledged OneGate CSSR Table of Contents 1 Introduction 1 1 Document history 1 2 References 1 3 Overview of document 2 Product features and capabilities 2 1 Product purpose 2 2 Scope of intended use 2 3 Scenario 3 Generalities 3 1 Communication protocol 3 2 Authentication 3 3 Authorization 3 4 Secure data 3 5 3 6 Binary data 3 7 Volume 3 8 Useful tools 4 HTTPS Entrypoint
11. Statistics PRSM IT Applications SYAS Network amp Application Security DSM Data Security Management WD OneGate CSSR End User Manual 1 3 Overview of document This manual is structured as follows seson the tampon Specifies the document version lists other related documents and 1 Introduction summarises the contents of this manual Explains why the product exists its scope and the scenario analysed Cenere Describes the generic points about the usage of the Web services HTTPS entrypoints description Explains how to use the product Product description and environment Some examples how to use the RL Appendix AMPIR USING Cu product using CURL o Lists and explains any special terms Definition of terms and abbreviations P 1 used in the document Lists and explains product error codes 5 Error codes and associated corrective actions OneGate CSSR 2 Product features and capabilities 2 1 Product purpose End User Manual Today the need for information grows continuously Administrative and statistical institutes interview the citizens and companies regularly to collect this information With the dematerialization the paper form has given way to electronic form sent via Internet The goal of the application One Gate CSSR is to become a unique point of data collection and data exchange for the National Bank of Belgium The data collection can be done either manually by filling an onlin
12. d receives a ticket in return This ticket is used as an acknowledgement of the file receipt and will be used to uniquely identify the file transfer The processing of the file is done asynchronously following the FIFO principle Due to the asynchronous process the validation report will not be available immediatly and there is a delay between the file upload and the registration of the file reception in OneGate CSSR Note that the processing of the declaration can be also followed via the online OneGate CSSR application using the function Exchanges gt File exchange log OneGate CSSR End User Manual The sent file contains a declaration report that must follow the data exchange protocol published by the business where the XML schema and the security level will be specified List of the supported XML protocols e Declaration Report cfr 3 all new reporting e XML protocol of the old CSSR application e Other specific protocols like for the CKO 2 Supported security level to apply to the sending file e None e Signed e Signed and encrypted 4 2 2 URL Test https onegate a2a test nbb be crs esb invoke uploadFile v2 0 Production _https onegate a2a nbb be crs esb invoke uploadFile v2 0 4 2 3 HTTPS Request 4 2 3 1 Body The payload body of the request contains the declaration report to upload to OneGate CSSR Before being sent the payload must fulfil the following requirements e The declaration report must be valid again
13. e file when getting a file with HTTPS or FIPS The certificate must be in PEM format If the optional password isn t specified it will be queried for on the terminal Note that this option assumes a certificate file that is the private key and the private certificate concatenated See cert and key to specify them independently H header lt header gt HTTP Extra header to use when getting a web page You may specify any number of extra headers Note that if you should add a custom header that has the same name as one of the internal ones curl would use your 28 OneGate CSSR End User Manual externally set header will be used instead of the internal one This allows you to make even trickier stuff than curl would normally do You should not replace internally set headers without knowing perfectly well what you re doing Remove an internal header by giving a replacement without content on the right side of the colon as in H Host Curl will make sure that each header you add replace is sent with the proper end of line marker you should thus not add that as a part of the header content do not add newlines or carriage returns they will only mess things up for you v verbose Makes the fetching more verbose talkative Mostly useful for debugging A line starting with gt means header data sent by curl lt means header data received by curl that is hidden in normal cases and a line starting with means addi
14. e form either Semi automatically by sending XML file via a manual file upload a secured email or a web service call The current document is limited to the description of the fully automated data exchange using the HTTPS entrypoints drawn in Figure 1 under point 3 You can also fully automated the data exchange using the Web Services instead of the HTTPS entrypoints The Webservice entry points are described in document 2 CASO External declarers User A2A Upload declaration report Request list of available feedbacks Request feedback HTTPS HTTPS HTTPS HTTPS HTTPS SMTP HTTPS HTTPS HTTPS HTTPS HTTPS L Request list of available messages M Request message Figure 1 General overview OneGate CSSR Application Server OneGate CSSR End User Manual 2 2 Scope of intended use OneGate CSSR can be used for all business domain where data must be collected via Internet Only the authorized users can use the OneGate CSSR Entrypoints Once you have done the technical effort to automate the exchange for a certain business domain you can reuse this implementation for all other business domains 2 3 Scenario For the data collection process the data exchange with the application OneGate CSSR consists of four chronological activities e The declarer sends a file containing one declaration report e The declarer requests the list of the available feedbacks e The declarer reque
15. feedback format is fixed XML following the protocol used for the FeedbackReport Feedback Back Office The feedback back officeis a report generated manually or automatically by the specific business application that will exploit the data collected via OneGate CSSR This report can contain information related to a second level of validation of the reported data or other types of information such as complementary question or various information The file format of the business report is free HTML xls doc PDF FIFO First In First Out can be translated as First come First served This expression describes the principle of a queue processing where what comes in first is handled first what comes in next waits until the first is finished before being handled HTTPS Hypertext Transfer Protocol Secure is a combination of the Hypertext Transfer Protocol with the SSL TLS protocol to provide encryption and secure identification of the server NBB National Bank of Belgium SOAP Simple Object Access Protocol SOAP is a lightweight protocol intended for exchanging structured information in a decentralized distributed environment It uses XML technologies to define an extensible messaging framework providing a message construct that can be exchanged over a variety of underlying protocols The framework has been designed to be independent of any particular programming model and other implementation specific semantics Definition from http www w
16. ommunication protocol The communication protocol used is HTTPS with SSLv3 certificate based authentication The method invocation is POST except for the GetFeedback using the url received in the FeedbackResponse Important The client must allow a http 302 redirect for authentication After authentication a http 302 is received and the request is redirected to the service Take care e there are two redirects http 302 o aredirect to the NBB login proxy nbbloginproxy authenticationbackend o ater the NBB login proxy decided you have access to the requested url you are redirected again to the original url ex https ocdpack test nbb be soap nbb e the client has to follow these redirections with a POST Be carefull not to transform the request from a POST to a GET The backend server is waiting for a POST e after each redirection we continue using the same protocol always HTTPS e persistency cookies are necessary to handle these redirections Otherwise the request will be redirected to the login proxy again and loop Some languages provide a library that manages these redirections for you Java developers can use the Apache HttpClient library 3 2 Authentication The communication protocol used is HTTPS with SSLv3 certificate based authentication The certificate based authentication means that remote users get authenticated using a X509 certificate The application OneGate CSSR recognizes the certificate from NBB
17. rtificate Export Wizard Issued To Issued By Expiratio Friendly Name Eshttp www valicert comf http fwwwevalicert c 2019 06 26 YaliCert Class Eghttp www valicert comf https iiwww valicert c 2019 06 26 YaliCert Class E_http www valicert comf http iiwww yvalicert c 2019 06 26 YaliCert Class Ers SERVIDORES IPS SERVIDORES 2009 12 30 IPS SERVIDOR E Microsoft Authenticode t Microsoft Authenticod 2000 01 01 Microsoft Auth E microsoft Root Authority Microsoft Root Authority 2020 12 31 Microsoft Root E microsoft Root Certificate Microsoft Root Certifi 2021 05 10 Microsoft Root 5 National Bank of Belgium National Bank of Belgium 2013 02 05 lt None gt v gi Certificate intended purposes Export File Format Certificates can be exported in a variety of file Formats Select the format you want to use DER encoded binary 509 CER Base 64 encoded x 509 CER Cryptographic Message Syntax Standard PKCS 7 Certificates P7B lt All gt 6 2 Command cURL 6 2 1 Parameters data binary lt data gt HTTP This posts data exactly as specified with no extra processing whatsoever If you start the data with the letter the rest should be a filename Data is posted in a similar manner as data ascii does except that newlines are preserved and conversions are never done E cert lt certificate password gt SSL Tells curl to use the specified certificat
18. s Domain 4 6 3 HTTPS Request 4 6 3 1 Body The request of a specific feedback must be fulfill the XML format described below crs NotRead Request only the message that have newer been requested ireaded SS SS MessageListRequest crs ReadType Request a list of message aa a identifier available For requester Request only the message that hawe been already requested readed during the ot Dea a a oe er ak specified time frame ann MessageListRequest NotRead TimeFrame 21 OneGate CSSR End User Manual ToTime cr HoMessage Ho message Found crs Messageld 1 05 MessageListResponse List of identifier of the message available for the requested parameters List oF message identifier MessageListResponse Status code Reason phrase Corrective action EEE 6 Max value 2 63 1 9223372036854775807 22 OneGate CSSR End User Manual 4 7 2 URL Test https onegate a2a test nbb be crs esb invoke requestMessage v2 0 Production _https onegate a2a nbb be crs esb invoke requesiMessage v2 0 These are general URLs for OneGate Each Business Domain has his proper own URL Please consult the URL document for the desired Institute Business Domain 4 7 3 HTTPS Request 4 7 3 1 Body The request of a specific feedback must be fulfill the XML format described below MessageRequest E cre Messageld Request a
19. s description 4 1 Overview 4 2 Upload file 4 3 Request list of available feedback 4 4 Request a feedback 4 5 GET an attachment of a feedback 5 Error codes 5 1 Client error 5 2 Server error 6 Appendix Sample using CURL 6 1 Prerequisites 6 2 Command cURL 7 Definition of terms and abbreviations End User Manual oR AR P NNOO 26 26 26 2 28 32 OneGate CSSR End User Manual 1 Introduction This document contains everything you need to automate the data exchange with the application OneGate CSSR This document describes the prerequisites of the usage of the OneGate CSSR HTTPS Entrypoints the goal of each one of them its input output and possible errors Target audience for this document is the external partners who wish to automate the data exchange with the application OneGate CSSR using the HTTPS Entrypoints Note that all of those services are also available in a Web Service version using SOAP 1 1 Document history 1 2 References Ret Tile Atha Location a a 2 OneGate CSSR End User manual Web Services PRSM mais 3 OneGate CSSR XML Protocol PRSM Not available 4 File Exchange Mechanism S MIMEv2 Specifications SYAS Not available French Dutch NBB Certificate policy 7 Certificate management Enrollment procedure v3 2 English Not available NBB Certificate Practice Statement for External Counterparties CPS DQ Department General
20. s org TR soap SSL Secure Socket Layer are cryptographic protocols that provide security for communications over networks such as the Internet U2A User to Application refers to the interaction between an user and an application Web Service A Web service is a software system designed to support interoperable machine to machine interaction over a network It has an interface described in a machine processable format specifically WSDL Other systems interact with the Web service in a manner prescribed by its description using SOAP messages typically conveyed using HTTPS with an XML serialization in conjunction with other Web related standards Definition issue from the W3C WSDL Web Services Definition Language WSDL is an XML based language for describing Web services and how to access them 32
21. signed and encrypted data Depending of the data sensitivity the business will be required to send the data e without additional signing or encryption e signed to authenticate the sender and guarantee the data integrity e signed and encrypted o authenticate the sender and guarantee the data integrity o guarantee that only the receiver can read the data Exchange of signed and or encrypted files from to the NBB will occur with files which comply with the S MIMEv2 standard described in document referenced by 4 The communication protocol used is HTTPS with SSLv3 certificate based authentication The method invocation is POST Important the cliend must allow http 302 redirect for authentication After authentication an http 302 is received and the request Is redirected to the service Authentication to know which certificate can be used to sign data Server certificate the public key of the server certificate used to encrypt sign data is available on the OneGate CSSR web site 3 6 Binary data The data exchange between the declarer and the application OneGate CSSR will be done using different file formats XML PDF Word document and different levels of security In native HTTPS the payload can be passed without encoding or in base64 encoded format 3 7 Volume The size of the request cannot exceed 10 MB The size of the payload of the HTTPS GET reply is limited depending on the specific Institute Business Domain To limi
22. specific message Identifier of the requested message MessageRequest Messageld 7 Max value 2 63 1 9223372036854775807 23 OneGate CSSR End User Manual P E nga MessageResponse crs Message Message MessageResponse i d Message 8 contentType can also have the following values application zip application pdf or text csv 24 OneGate CSSR End User Manual Status code Reason phrase Corrective action Status code Reason phrase Corrective action 25 OneGate CSSR End User Manual 5 Error codes If the request could not be processed due to a client error or a server error the response will contain respectively a status code An overview of HTTP error codes can be found in 5 1 Client error If your request contains something wrong the response returns a status code in the 400 range and a reason phrase given an indication that the problem is located at the client side In this case please correct your request before send it again Status code Reason phrase Detail Different problems can cause this error code 1 User certificate missing or rejected No certificate found in your request You need to register your certificate or a new one Client certificate has expired or is not yet valid You need to request a new certificate and restart the registration procedure The request exceeds the max allowed content length Your request exceeds the
23. st the XML protocol fixed by the business e Only one file can be uploaded by request e The file can be compressed In this case the zip file can contains only one file e Following the business requirements the file must be signed or signed and encrypted So to generate the payload you need to execute the following steps e Validate the file against the XML schema optional but recommended e Zip file optional but recommended e Sign the file with your private key required or not by the business requirement e Encrypt the file with the OneGate CSSR public key required or not by the business requirement 4 2 3 2 Header You can give a name to the file uploaded by specifying the HTTPS header filename This header is optional 4 2 4 HTTPS Response If the OneGate CSSR has successfully received the payload the response returns a status code 200 and the ticket ID associated to the file upload The response is sent in the XML format described below UploadFileResponse e E crs TicketID OneGate CSSR End User Manual UploadFileResponse Description Contains the ticket id associated with the file exchange XML format ComplexType Children TicketID TicketID Description the file transfer uniquely The ticket ID is used as an acknowledgement of the file receipt and will be requested in case of problem by the Service Desk to be able to detect the problem XML format xs string whitespace collapse Validation Required
24. sts a specific feedback ProcessFile SS T T L 1 FeedbackListRequast FeedbackListRequest m FeedbackListResponse Q FeedbackListResponse a 1 Tn D l C For each entry of the T FeedbackListResponse FeedbackReguest FeedbackRequest FeedbackResponse FeadbackResponse contains only URL s where feedbacks can be retrieved i i i l Feedback File Server For each attachment in LU the FeedbackResponse i 0 HTTPS GET U using URL s received x 1 in FeedbackResponse L Feedback l Figure 2 Scenario of the fully automated data exchange with OneGate CSSR for data collection OneGate CSSR End User Manual ac Declarer AGA ESB OneGate CSSR MessageListReguest MessageListRequest MessaqgeListhasponse MassageLisiResponsa For each entry of the MessageListheasponse MessageRequast MassageRequest HTTPS POST MessageResponse MessageResponse contains only URL s where messages can be retrieved Message File Server For each attachment in the MessageResponse HTTPS GET using URL received in MessageResponse HTTPS GET OneGate CSSR End User Manual 3 Generalities This chapter describes the generalities about the OneGate CSSR Entrypoints the communication protocol the authentication the authorization and the binary data format 3 1 C
25. t this size payload can be compressed If zip is used the content type of the attachment will be application zip OneGate CSSR End User Manual 3 8 Useful tools Before automated the implementation of the usage of the HTTPS Entrypoints you can easily test it using CURL http curl haxx se CURL is a command line tool for transferring files with URL syntax supporting FTP FIPS HTTP HTTPS SCP SFTP TFTP TELNET DICT LDAP LDAPS and FILE CURL supports SSL certificates HTTPS POST HTTPS PUT FTP uploading HTTPS form based upload proxies cookies user password authentication Basic Digest NTLM Negotiate kerberos file transfer resume proxy tunneling and a busload of other useful tricks OneGate CSSR End User Manual 4 HTTPS Entrypoints description 41 Overview uploadFile requestFeedbackList d requestFeedback 7N User A2A messageListRequest e A StS messageRequest o v Figure 4 HTTPS Entrypoints services Figure 4 gives an overview of the HTTPS Entrypoints used by the declarer to fully automate the data exchange with the application OneGate CSSR As a reminder the data exchange consists of sending data and retrieving the associated feedback that contains the result of the validation of the imported data 4 2 Upload file 4 2 1 Description The declarer uses the service Upload file to send a file with a declaration report to be processed by the application OneGate CSSR an
26. the Feedback that have never been requested readed FeedbackListRequest Request a list of Feedback identifier associated to file previously uploaded by the user crs ReadType eee eg ue H Timerne BH Request only the Feedback that have been already requested readed during the SSS eS specified time Fame E FeedbackListRequest Description Contains the attributes to request the list of feedback identifiers available for the requester XML format ComplexType S O Children NotRead Read NotRead Description Used to request the identifiers of new feedback XML format ComplexType Validation Empty element Read Description Used to request the identifiers of feedback requested XML format ComplexType Children TimeFrame TimeFrame Description Used to specify the time frame during which the file has been the application OneGate CSSR T Children FromTime ToTime FromTime Description Timestamp identifying the start of the time frame XML format xs date Time Validation Required ToTime Description Timestamp identifying the end of the time frame XML format xs dateTime Validation Required OneGate CSSR End User Manual 4 3 3 2 Header No specific header 4 3 4 HTTPS Response If OneGate CSSR has successfully processed the request the response returns a status code 200 and the list of the available feedbacks in the XML format described below crs NoFeedback Mo Feedback
27. tional info provided by curl Note that if you only want HTTPS headers in the output i include might be the option you re looking for 6 2 2 Upload file 6 2 2 1 Command cURL With file name CUr I v7 L b cookies post302 H e eerti eate Dems password S data Danay E E H filename lt filename gt Sew Meco e onegate a2a e be crs esb invoke uploadFile v2 0 Without file name Curl y L b cookies post302 H certificate pem password gt data Dinary a filepath i https onegate a2a nbb be crs esb invoke uploadFile v2 0 6 2 2 2 HTTPS Request Sample of declarationReport xml lt 2 version T eL Om encoding UIF is a lt DeclarationReport xmlns http www onegate eu 2010 01 01 gt lt Administration gt lt From declarerType KBO gt 0100200300 lt From gt To NEE Wo 29 OneGate CSSR End User Manual lt Domain gt FRO lt Domain gt lt Response feedback true gt lt Email gt frank osaer nbb be lt Email gt lt Language gt EN lt Language gt lt Response gt lt Administration gt Poe ese relic Scare 7000 0 o ek Oona Doe BIOL LCM CS lece T lt Item gt lt Dim prop AMOUNT gt 100 lt Dim gt lt Daim prop IMPEXTI IMPORT Dim lt Dim prop INTEXT2 gt INTRA lt Dim gt lt Item gt lt Item gt lt Dim prop AMOUNT gt 200 lt Dim gt lt Dim pro IMPEXT IMPOR Dim Pin pop INE TA EXTRA Dim lt Item gt lt Data gt T lt DeclarationReport gt 6 2
Download Pdf Manuals
Related Search