bizzTainer web connector user guide
Contents
1. IS0 8859 1 gt lt ORDERRESPONSE version 1 0 gt lt ORDERRESPONSE gt 5 3 3 putMessage This is the client request to upload a message POST btp connector rest putMessage HTTP 1 1 Content type text xml charset ISO 8859 1 Authorization Basic dXN1cjE6dXN1cjE User Agent Jakarta Commons HttpClient 2 0 2 Gest 127 05 ib Content Length 4948 lt xml version 1 0 encoding UTF 8 gt lt ORDER version 1 0 gt lt ORDER gt which returns the following response ATTE OO OR X Cocoon Version 2 1 4 Expires Thu 26 May 2005 11 56 06 Gur Cache Control max age 1 public Content Type text xml Transfer Encoding chunked Date Thu 26 May 2005 11 56 11 GMT Server Apache Coyote 1 1 2al lt xml version 1 0 enceding 1S0 8859 1 gt lt conn connector gt lt conn upload message gt lt transform gt lt message gt ORDER lt message gt lt btid new true gt BT10049001 20050526 135605937 C0A800BC0000010418DBF7B100000002 xml lt btid gt lt results gt lt result step save uploaded message gt success lt result gt lt result step results gt success lt result gt lt result step map message gt success lt result gt lt result step validate gt success lt result gt lt result name find partners gt suc cess lt result gt lt result name analyse partners pipeline gt success lt result gt lt result step set status gt suc cess lt result gt lt results gt lt transform gt lt conn upload message gt2. lt conn connector gt 5 4 Java example code tre 06 06 05 15 25 16 The following example code makes basic use of the bizzTainer REST connector Page 12 15 document version 1 0 bizzTainer web connector user guide tre 06 06 05 15 25 16 Page 13 15 document version 1 0 bizzTainer web connector user guide tre 06 06 05 15 25 17 Page 14 15 document version 1 0 bizzTainer web connector user guide tre 06 06 05 15 25 17 Page 15 15 document version 1 0
3. 1 0 bizzTainer web connector user guide mare d T MI a Commerce e exx Tainer 5 REST style interface This section describes the REST style specific parameters of the functions described in the general section 5 1 REST service URLs The bizzTainer REST service URLs are listed below where lt your bizztainer host gt is the URL of the bizzTainer hub you are connected to http lt your bizztainer host gt btp connector rest getList http lt your bizztainer host gt btp connector rest getMessage lt btcid gt lt messageType gt http lt your bizztainer host gt btp connector rest setMessageOK lt btcid gt lt messageType gt http lt your bizztainer host gt btp connector rest putMessage lt btcid gt and lt messageType gt are the actual bizzTainer ids and message ty pes you want to access See the example section for this 5 2 Access parameters The login parameters are transferred as a HTTP header parameter ac cording to RFC 2617 HTTP Authentication The parameters connector login and connector password are transferred in the HTTP header as Authorization Basic connector login connector password where the string connector login connector password is base64 encoded Please watch that connector login and connector password are separated by a A real life example would therefore look like Authorization Basic dXNlcjE6dXN1cjE Since the login parameters are trans
4. ace gt lt nsl getListReturn href id0 gt lt nsl getListResponse gt lt multiRef id id0 soapenc root 0 soapenv encodingStyle http schemas xmlsoap org soap enco ding xsi type ns2 Document xmlns soapenc http schemas xmlsoap org soap encoding xmlns ns2 http xml apache org xml soap gt lt messages gt lt message gt btcidl lt message gt lt message gt btcid2 lt message gt lt message gt btcid3 lt message gt lt messages gt lt multiRef gt lt soapenv Body gt lt soapenv Envelope gt 4 3 2 getMessage This is the client request to get a message POST btp connector soap service HTTP 1 0 Content Type text xml charset utf 8 Accept application soap xml application dime multipart related text User Agent Axis 1 1 kesre 127 HEEN Cache Control no cache Pragma no cache SOAPAction Content Length 665 lt xml version 1 0 encoding UTF 8 gt lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope xmlns xsd http ww w w3 0rg 2001 XMLSchema xmlns xsi http www w3 0rg 2001 XMLSchema instance gt lt soapenv Body gt lt nsl getXmlMessage soapenv encodingStyle http schemas xmlsoap org soap encoding xmlns nsl http DefaultNamespace gt lt connectorLogin xsi type xsd string gt userl lt connectorLogin gt lt connectorPassword xsi type xsd string gt userl lt connectorPassword gt lt bizzTainerID xsi type xsd string gt BT lt bizzTaine
5. ameters The bizzTainer web connector interfaces support four functions for the ac cess to a bizzTainer hub The following sections describe the functions in general whereas the imple mentation specific details are described in the SOAP and REST sections All functions return an XML document as a response The receiving applica tion must evalute this for failures and success Please note that due to the SOAP messaging overhead the execution time of a SOAP function takes about twice the time of executing the corresponding REST style function All functions mentioned in the following two sections need authorization in formation in order to proceed This means that you have to transfer the connector login information configured on the bizzTainer hub you want to connect to Your bizzTainer administrator has to activate the connector access and can set the parameters connector login typically your bizzTainer id and connector password You must add to all of the following functions your login connector login and password connector password otherwise the calls will fail with not autho rized 3 2 Functions for message download The functions for message download are 1 getList This retrieves a list of available messages for download The list con taines the message type and the bizzTainer container id 2 getMessage messageType btcid This downloads the message of type messageType from the bizzTainer
6. bizzTainer web connector user guide ra al 2 n Commerce a exxTainer bizzTainer web connector user guide Version 1 1 0 O exxTainer Commerce GmbH Germany tre 06 06 05 15 25 15 Page 1 15 document version 1 0 bizzTainer web connector user guide mera d T Kid nu Commerce D exx Tainer Contents Tute e TEE 3 ME EE ne E WEE 3 3 Usage of the tele 4 Nee EE A 3 2 Functions for message download 4 3 3 Function for message UI cocaina 4 SOAP interface 5 4 1 SOAP service URLs sii 5 4 2 ACccess iparametelSi a rn EE 5 43 Message transfer ernia A ing RENI Re pn REN PRESI nile 5 SN Ee EE 5 E e EE iaia eo ina fici 6 43 9 SetMessage OK citar ani lalla iii 6 4 3 4 PU MESSAGG EE 7 EVER E iin aea eaa a a aaae asa E aai enaa aaah Ea Eai EE EEE 8 5 REST Style interface criari di lea 11 Del REST Service URLS AE in 11 5 2 ACCESS parameter Siriei ARI 11 5 3 Message transfer ii 11 9 91 O A ll aa all iii alari 11 5 3 2 E EE 12 5 3 3 PUIMESSAGO cviciiii iii aiar 12 5 4 Java example code coccccoccccccccccnnnn nc RR R RR nn rn nana rerannnmes 12 Namentlich genannte Hard und Softwareprodukte sind Warenzeichen oder eingetragene Warenzeichen der jeweiligen Firmen tre 06 06 05 15 25 16 Page 2 15 document version 1 0 bizzTainer web connector user guide 1 Introduction 2 Messages exchanged tre 06 06 05 15 25 16 Mi Ta d Aw MI n Commerce e exx Tainer This document descr
7. container with the id btcid 3 setMessageOK messageType btcid If the download of the message to your local system was successful this function needs to be called in order to set the message status on the bizz Tainer hub correctly to downloaded Do not forget this because otherwise the next call to getList will list you this message again and you may import this into your system again 3 3 Function for message upload tre 06 06 05 15 25 16 The function for message upload is putMessage message This uploads the message message XML in openTRANS format to the bizzTainer hub If neccessary a new bizztainer container is created and depending on your bizzTainer hub settings the message is automatically transferred to the recipient Page 4 15 document version 1 0 bizzTainer web connector user guide ma d T Kid nu Commerce e exx Tainer 4 SOAP interface This section describes the SOAP specific parameters of the functions de scribed in the previous section 4 1 SOAP service URL The bizzTainer SOAP service URL is http lt your bizztainer host gt btp connector soap service where lt your bizztainer host gt is the URL of the bizzTainer hub you are connected to 4 2 Access parameters The login parameters are transferred as additional SOAP method parame ters See the WSDL description in http lt your bizztainer host gt btp connector soap service wsdl for further d
8. etails Since the login parameters are transferred within the message make sure that you use the encrypted HTTPS protocol for message exchange 4 3 Message transfer The following data describe the SOAP message transfer between the SOAP client and a bizzTainer hub 4 3 1 getList This is the client request to get the list of available messages POST btp connector soap service HTTP 1 0 Content Type text xml charset utf 8 Accept application soap xml application dime multipart related text User Agent Axis 1 1 Geet 127 0 510 iL Cache Control no cache Pragma no cache SOAPAction Content Length 536 lt xml version 1 0 encoding UTF 8 gt lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope xmlns xsd http ww w w3 0rg 2001 XMLSchema xmlns xsi http www w3 0rg 2001 XMLSchema instance gt lt soapenv Body gt lt nsl getList soapenv encodingStyle http schemas xmlsoap org soap encoding xmlns nsl http DefaultNamespace gt lt connectorLogin xsi type xsd string gt userl lt connectorLogin gt lt connectorPassword xsi type xsd string gt userl lt connectorPassword gt lt nsl getList gt lt soapenv Body gt lt soapenv Envelope gt which returns the following response tre 06 06 05 15 25 16 Page 5 15 document version 1 0 bizzTainer web connector user guide AS d a A Al a Commerce A exxTainer xmlns nsl http DefaultNamesp
9. ferred within the message make sure that you use the encrypted HTTPS protocol for message exchange 5 3 Message transfer The following data describe the REST message transfer between the REST client and a bizzTainer hub 5 3 1 getList This is the client request to get the list of available messages GET btp connector rest getList HTTP 1 1 Authorization Basic dXNlcjE6dXNlcjE User Agent Jakarta Commons HttpClient 2 0 2 Hoste 1275050 1 which returns the following response tre 06 06 05 15 25 16 Page 11 15 document version 1 0 bizzTainer web connector user guide lt xml version 1 0 encoding UTF 8 gt lt messages gt lt message gt btcidl lt message gt lt message gt btcid2 lt message gt lt message gt btcid3 lt message gt lt messages gt 5 3 2 getMessage Mi Ta d Aw Ki Si 1 Commerce a exxTainer This is the client request to get a message GET btp connector rest getMessage BT10049001 20050519 180333656 C0A800B C00000103F5B2029800000007 xml ORDERRESPONSE HTTP 1 1 Authorization Basic dXNlcjE6dXNl1cjE User Agent Jakarta Commons HttpClient 2 0 2 Geet 127 0 510 4 which returns the following response arrei ZOO OR X Cocoon Version 2 1 4 Expires Thu 26 May 2005 11 54 29 GMT Cache Control max age 1 public Content Type text xml Transfer Encoding chunked Date Thu 26 May 2005 11 54 28 GMT Server Apache Coyote 1 1 ica lt xml version 1 0 encoding
10. ibes the usage of the bizzTainer web connectors to ac cess a bizzTainer hub via standard HTTP and HTTPS protocols All messages exchanged via these interfaces must be conform to the openTRANS standard version 1 0 Two interfaces are provided e SOAP interface e REST style interface The access to these will be described in the following sections All messages exchanged via the bizzTainer web connectors need to conform to the openTRANS standard version 1 0 See http www opentrans org for further information on these formats The web connectors have no mapping functionalities if you need this in order to connect to your inhouse system have a look at the bizzTainer connector which is especially designed for mapping an complex integration purposes http www bizztainer org The messages that can be exchanged with the bizzTainer hub are the openTRANS message types e RFQ request for quotation e QUOTATION quotation e ORDER order e ORDERRESPONSE order response e DISPATCHNOTIFICATION dispatch notification e INVOICE invoice If you connect to a bizzTainer hub via a the SOAP or REST style interface the messages you upload MUST conform to this standard otherwise the upload will fail All messages downloaded are also in openTRANS format Page 3 15 document version 1 0 bizzTainer web connector user guide a d Aw Kl n Commerce e exx Tainer 3 Usage of the Functionalities 3 1 Access par
11. l parsers DocumentBuilderFactory org org org org org Oi com com com author sr apache commons logging LogFactory xml serialize OutputFormat apache apache apache commons logging Log xml serialize XMLSerializer w3c dom Document xml sax InputSource exxtainer SOAPConnector SOAPConnector exxtainer SOAPConnector SOAPConnectorService tre exxtainer SOAPConnector SOAPConnectorServiceLocator public class SimpleSOAPConnector private sta tic final Log log LogFactory getLog SimpleSOAPConnector class public static void usage System out println usage SimpleSOAPConnector keywords options System out System out System out TRANSMITTED System t System E System E System E System t mc a CH interfaces basic SOAP services of the bizzTainer hub caca pu y a ay MAKE SURE THAT YOU USE AN ENCRYPTED CONNECTION SINCE YOUR PASSWORD IS ui ENEE url lt url gt URL of the bizzTainer SOAP services Out pi nie ra login lt login gt connector login QUER arme la pe password lt password gt connector password cut prite init message lt message gt message to get or set to download OK tre 06 06 05 15 25 16 Page 8 15 document version 1 0 bizzTainer web connector user guide tre 06 06 05 15 25 16 Page 9 15 document version 1 0 bizzTainer web connector user guide tre 06 06 05 15 25 16 Page 10 15 document version
12. nv http schemas xmlsoap org soap envelope xmlns xsd http ww w w3 0rg 2001 XMLSchema xmlns xsi http www w3 0rg 2001 XMLSchema instance gt lt soapenv Body gt lt nsl setXmlMessage soapenv encodingStyle http schemas xmlsoap org soap encoding xmlns nsl http DefaultNamespace gt lt connectorLogin xsi type xsd string gt userl lt connectorLogin gt lt connectorPassword xsi type xsd string gt userl lt connectorPassword gt lt xmlMessage href id0 gt lt nsl setXmlMessage gt lt multiRef id id0 soapenc root 0 soapenv encodingStyle http schemas xmlsoap org soap enco ding xsi type ns2 Document xmlns soapenc http schemas xmlsoap org soap encoding xmlns ns2 http xml apache org xml soap gt lt ORDER version 1 0 gt tre 06 06 05 15 25 16 Page 7 15 document version 1 0 bizzTainer web connector user guide lt ORDER gt lt multiRef gt lt soapenv Body gt lt soapenv Envelope gt which returns the following response Ad T E Commerce exx 4 4 Java example code package com import import import import import import import import import import import import import java java java The following example code makes basic use of the bizzTainer SOAP connector The access functions are generated using Apache Axis version 1 1 from the WSDL data mentioned above exxtainer client io FileInputStream io StringWriter net URL javax xm
13. rID gt lt messageName xsi type xsd string gt ORDER lt messageName gt lt nsl getXmlMessage gt lt soapenv Body gt lt soapenv Envelope gt which returns the following response HTTP 1 1 200 OK Set Cookie JSESSIONID 5A423337C45B737B729F63EA3B931E5D Path axis Content Type text xml charset utf 8 Date Fri 20 May 2005 14 25 08 GMT Server Apache Coyote 1 1 Connection close lt xml version 1 0 encoding UTF 8 gt lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope xmlns xsd http ww w w3 0rg 2001 XMLSchema xmlns xsi http www w3 0rg 2001 XMLSchema instance gt lt soapenv Body gt lt nsl getXmlMessageResponse soapenv encodingStyle http schemas xmlsoap org soap encoding xmlns nsl http DefaultNamespace gt lt nsl getXmlMessageReturn href id0 gt lt ns1 getXmlMessageResponse gt lt multiRef id id0 soapenc root 0 soapenv encodingStyle http schemas xmlsoap org soap enco ding xsi type ns2 Document xmlns soapenc http schemas xmlsoap org soap encoding xmlns ns2 http xml apache org xml soap gt lt ORDER gt lt ORDER gt lt multiRef gt lt soapenv Body gt lt soapenv Envelope gt 4 3 3 setMessageOK This is the client request to commit a successful download of a message POST btp connector soap service HTTP 1 0 Content Type text xml charset utf 8 tre 06 06 05 15 25 16 Page 6 15 document version 1 0 bizzTainer web connector u
14. ser guide Up ipa Ta 3 i ll n Commerce Ha exxTa Accept application soap xml application dime multipart related text User Agent Axis 1 1 Gesetz 127 001 Cache Control no cache Pragma no cache SOAPAction Content Length 739 lt xml version 1 0 encoding UTF 8 gt lt soapenv Envelope xmlns soapenv http schemas xmlsoap org soap envelope xmlns xsd http ww w w3 0rg 2001 XMLSchema xmlns xsi http www w3 0rg 2001 XMLSchema instance gt lt soapenv Body gt lt nsl setXmlMessageOK soapenv encodingStyle http schemas xmlsoap org soap encoding xmlns nsl http DefaultNamespace gt lt connectorLogin xsi type xsd string gt userl lt connectorLogin gt lt connectorPassword xsi type xsd string gt userl lt connectorPassword gt lt bizzTainerID xsi type xsd string gt BT lt bizzTainerID gt lt messageName xsi type xsd string gt ORDER lt messageName gt lt nsl setXmlMessage0K gt lt soapenv Body gt lt soapenv Envelope gt which returns the following response 4 3 4 putMessage This is the client request to upload a message POST btp connector soap service HTTP 1 0 Content Type text xml charset utf 8 Accept application soap xml application dime multipart related text User Agent Axis 1 1 hosce LAT 00 Cache Control no cache Pragma no cache SOAPAction Ue Content Length 6077 lt xml version 1 0 encoding UTF 8 gt lt soapenv Envelope xmlns soape
Download Pdf Manuals
Related Search