BANCO NACIONAL DE PANAMÁ, BANCO DE DESARROLLO AGROPECUARIO Y BANCO HIPOTECARIO NACIONAL

Transcripción

1 BANCO NACIONAL DE PANAMÁ, BANCO DE DESARROLLO AGROPECUARIO Y BANCO HIPOTECARIO NACIONAL LICITACION ABREVIADA POR PONDERACIÓN Nº AV MANUAL DE SERVICIOS DE WEB

2 DOCUMENTATION CUSTOMER SERVICES 1

3 CUSTOMER SERVICES 1. DEPLOYMENT: NAME TYPE FUNCTION Axis2 WAR Web Services Engine customerservice AAR Deployment File 2. COMPONENTS DEFINITION: NAME TYPE FUNCTION customerservice.wsdl WSDL Web Service Description CustomerServiceSkeleton JAVA Class for service impl. EWS000001Message JAVA Message Class. 3. FUNCTIONAL METHODS SUMMARY personalcustomerinquiry: Personal customer inquiry service. Parameters: o <user>- a String data type; sends the user that is soliciting the transaction.. o <customerid>- a String data type; sends the customer identification number. Returns: <PersonalCustMessage> - a data structure containing all the Customer data defined in the WSDL file. Error: <Validation Error> - Error message structure using an exception type errormessage defined in the WSDL file. personalcustomermaintenance: Personal customer maintenance service, it must include the customer number in the message. Parameters: <PersonalCustMessage> - a data structure containing all the customer data defined in the WSDL. Returns: <PersonalCustMessage> - a data structure containing all the customer data defined in the WSDL. Error: <Validation Error> - Error message structure using an exception type errormessage defined in the WSDL file. newpersonalcustomer: Personal customer creation service. The field customer number must be filled with zeros, the response message must return the new generated customer number. 2

4 Parámetros: <PersonalCustMessage> - una estructura de datos compuesta con toda la data de cliente definida en el WSDL. Returns: <PersonalCustMessage> - a data structure containing all the customer data defined in the WSDL. Error: <Validation Error> - Error message structure using an exception type errormessage defined in the WSDL file. The error message is a SOAP message, never the less this message is generated only when an exception is thrown from the published method. This means that in the client side the error message will be obtain in a catch block. Currently the error its being sent in a String with the following form: <error code>-<error description> The error codes correspond to the same codes that are handled in the e-ibs system for form validations. The descriptions of some parameterized fields were added to the message, some of the codes that need description have fixed values, and the details about these values are summarized in the following table: legalstatus Sex relationtype clientstatus clienttype clientclass language taxes FIELD DETAIL 1=Single 2=Married, 3=Divorced, 4=Widow, 5=others M=Male, F=Female 1 Regular Customer 2 Special 3 Employee 4 Functionary 5 Director 6 Relative 7 Affiliated Company 8 Directive Board 9 Corresponsal Bank 1=active, 2=inactive, 3=Black list 1=corporation, 2=personal, 3=others 1= Governmental Entity, 2= Decentralized entity, N=Doesn t Apply s=spanish e=english Fixed values from 1 to 9 or N 4. FUNCIONALIDAD To access the web services functionalities it s required to build a client, starting from the WSDL file attached to this document, the Web Service client in this case will be Ultimus, who will have 3

5 to build the client in their application and who will exchange SOAP messages through http with Datapro s service that is published in the following URL: The WSDL file can be obtain through this URL: Here we present a small example of how to handle SOAP messages: Methods Signature PersonalCustMessage personalcustomerinquiry(string customerid); Where the complex type PersonalCustMessage is defined as PersonalCustMessage { String firstname; String secondname; String phonenumber; all the response fields } Request <?xml version="1.0" encoding="utf-8" standalone="no"?> <SOAP-ENV:Envelope SOAP- ENV:encodingStyle=" xmlns:soap-env=" xmlns:soap-enc=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:personalcustomerinquiry xmlns:ns1="urn:mysoapservices"> <user xsi:type="xsd:string">bptdatapro</user> <customerid xsi:type="xsd:string"> </customerid> </ns1:personalcustomerinquiry> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response <?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap-env=" <SOAP-ENV:Body> <ns1: personalcustomerinquiryresponse xmlns:ns1="urn:mysoapservices" SOAP- ENV:encodingStyle=" 4

6 <return xsi:type="ns1:personalcustmessage"> <firstname xsi:type="xsd:string">bill</firstname> <secondname xsi:type="xsd:string">gate</secondname> <phonenumber xsi:type="xsd:string"> </phonenumber> all the response fields </return> </ns1: personalcustomerinquiryresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> With the WSDL file all the necessary elements to create the client to access the service can be generated. The WSDL file is attached below. 5

7 5. ATTACHMENTS: <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions targetnamespace=" xmlns:impl=" xmlns:intf=" xmlns:tns2=" xmlns:wsdl=" xmlns:wsdlsoap=" xmlns:xsd=" <wsdl:types> <schema elementformdefault="qualified" targetnamespace=" xmlns=" xmlns:impl=" xmlns:intf=" xmlns:wsdl=" xmlns:xsd=" <complextype name="personalcustmessage"> <sequence> <element name="user" nillable="true" type="xsd:string"/> <element name="idnumber" nillable="true" type="xsd:string"/> <element name="clienttype" nillable="true" type="xsd:string"/> <element name="idcountry" nillable="true" type="xsd:string"/> <element name="idtype" nillable="true" type="xsd:string"/> <element name="customernumber" nillable="true" type="xsd:string"/> <element name="firstname" nillable="true" type="xsd:string"/> <element name="secondname" nillable="true" type="xsd:string"/> <element name="firstlastname" nillable="true" type="xsd:string"/> <element name="secondlastname" nillable="true" type="xsd:string"/> <element name="marriedname" nillable="true" type="xsd:string"/> <element name="legalname" nillable="true" type="xsd:string"/> <element name="shortname" nillable="true" type="xsd:string"/> <element name="dependents" nillable="true" type="xsd:string"/> <element name="sex" nillable="true" type="xsd:string"/> <element name="legalstatus" nillable="true" type="xsd:string"/> <element name="nacionality" nillable="true" type="xsd:string"/> <element name="street" nillable="true" type="xsd:string"/> <element name="housenumber" nillable="true" type="xsd:string"/> <element name="province" nillable="true" type="xsd:string"/> <element name="distrit" nillable="true" type="xsd:string"/> <element name="correg" nillable="true" type="xsd:string"/> <element name="country" nillable="true" type="xsd:string"/> <element name="pobox" nillable="true" type="xsd:string"/> <element name="zipcode" nillable="true" type="xsd:string"/> <element name=" " nillable="true" type="xsd:string"/> <element name="birthdate" nillable="true" type="xsd:string"/> <element name="firstcontactdate" nillable="true" type="xsd:string"/> <element name="housephonenum" nillable="true" type="xsd:string"/> <element name="officephonenum" nillable="true" type="xsd:string"/> <element name="celularphonenum" nillable="true" type="xsd:string"/> <element name="faxnumber" nillable="true" type="xsd:string"/> <element name="mainofficer" nillable="true" type="xsd:string"/> <element name="secondofficer" nillable="true" type="xsd:string"/> <element name="industrycode" nillable="true" type="xsd:string"/> <element name="businesscode" nillable="true" type="xsd:string"/> 6

8 type="xsd:string"/> <element name="residencycountry" nillable="true" type="xsd:string"/> <element name="relationtype" nillable="true" type="xsd:string"/> <element name="educationlevel" nillable="true" type="xsd:string"/> <element name="profession" nillable="true" type="xsd:string"/> <element name="incomesource" nillable="true" type="xsd:string"/> <element name="risklevel" nillable="true" type="xsd:string"/> <element name="clientstatus" nillable="true" type="xsd:string"/> <element name="clientclass" nillable="true" type="xsd:string"/> <element name="groupnumber" nillable="true" type="xsd:string"/> <element name="language" nillable="true" type="xsd:string"/> <element name="taxes" nillable="true" type="xsd:string"/> <element name="referby" nillable="true" type="xsd:string"/> <element name="referbyn" nillable="true" type="xsd:string"/> <element name="familiarrelationtype" nillable="true" <element name="resident" nillable="true" type="xsd:string"/> <element name="inquirylevel" nillable="true" type="xsd:string"/> <element name="discountcompanyname" nillable="true" type="xsd:string"/> <element name="position" nillable="true" type="xsd:string"/> <element name="employmenttime" nillable="true" type="xsd:string"/> <element name="companytype" nillable="true" type="xsd:string"/> <element name="currentjentrydate" nillable="true" type="xsd:string"/> <element name="previusjentrydate" nillable="true" type="xsd:string"/> <element name="currentincome" nillable="true" type="xsd:string"/> <element name="perrefname1" nillable="true" type="xsd:string"/> <element name="perrefstreet1" nillable="true" type="xsd:string"/> <element name="perrefbuildnum1" nillable="true" type="xsd:string"/> <element name="perrefhousenum1" nillable="true" type="xsd:string"/> <element name="perrefprovince1" nillable="true" type="xsd:string"/> <element name="perrefdistrit1" nillable="true" type="xsd:string"/> <element name="perrefcorreg1" nillable="true" type="xsd:string"/> <element name="perrefcountry1" nillable="true" type="xsd:string"/> <element name="perrefpobox1" nillable="true" type="xsd:string"/> <element name="perrefzipcode1" nillable="true" type="xsd:string"/> <element name="perrefphonenum1" nillable="true" type="xsd:string"/> <element name="perrefname2" nillable="true" type="xsd:string"/> <element name="perrefstreet2" nillable="true" type="xsd:string"/> <element name="perrefbuildnum2" nillable="true" type="xsd:string"/> <element name="perrefhousenum2" nillable="true" type="xsd:string"/> <element name="perrefprovince2" nillable="true" type="xsd:string"/> <element name="perrefdistrit2" nillable="true" type="xsd:string"/> <element name="perrefcorreg2" nillable="true" type="xsd:string"/> <element name="perrefcountry2" nillable="true" type="xsd:string"/> <element name="perrefpobox2" nillable="true" type="xsd:string"/> <element name="perrefzipcode2" nillable="true" type="xsd:string"/> <element name="perrefphonenum2" nillable="true" type="xsd:string"/> <element name="countrydesc" nillable="true" type="xsd:string"/> <element name="idtypedesc" nillable="true" type="xsd:string"/> <element name="provincedesc" nillable="true" type="xsd:string"/> <element name="nacionalitydesc" nillable="true" type="xsd:string"/> <element name="distritdesc" nillable="true" type="xsd:string"/> <element name="corregdesc" nillable="true" type="xsd:string"/> <element name="mainofficerdesc" nillable="true" type="xsd:string"/> <element name="secondofficerdesc" nillable="true" type="xsd:string"/> <element name="industrycodedesc" nillable="true" type="xsd:string"/> 7

9 <element name="mainofficerdesc" nillable="true" type="xsd:string"/> <element name="secondofficerdesc" nillable="true" type="xsd:string"/> <element name="industrycodedesc" nillable="true" type="xsd:string"/> <element name="bussinescodedesc" nillable="true" type="xsd:string"/> <element name="residencycountrydesc" nillable="true" type="xsd:string"/> <element name="educationleveldsc" nillable="true" type="xsd:string"/> <element name="professiondesc" nillable="true" type="xsd:string"/> <element name="incomesourcedsc" nillable="true" type="xsd:string"/> <element name="riskleveldsc" nillable="true" type="xsd:string"/> <element name="companynamedsc" nillable="true" type="xsd:string"/> <element name="positiondsc" nillable="true" type="xsd:string"/> <element name="perrefprovince1dsc" nillable="true" type="xsd:string"/> <element name="perrefdistrit1dsc" nillable="true" type="xsd:string"/> <element name="perrefcorreg1dsc" nillable="true" type="xsd:string"/> <element name="perrefprovince2dsc" nillable="true" type="xsd:string"/> <element name="perrefdistrit2dsc" nillable="true" type="xsd:string"/> <element name="perrefcorreg2dsc" nillable="true" type="xsd:string"/> <element name="referbydsc" nillable="true" type="xsd:string"/> <element name="companyname" nillable="true" type="xsd:string"/> <element name="companyaddress" nillable="true" type="xsd:string"/> <element name="companyinfo" nillable="true" type="xsd:string"/> </sequence> </complextype> </schema> <schema elementformdefault="qualified" targetnamespace=" xmlns=" xmlns:impl=" xmlns:intf=" xmlns:tns2=" xmlns:wsdl=" xmlns:xsd=" <import namespace=" /> <element name="personalcustomerinquiry"> <complextype> <sequence> <element name="user" nillable="true" type="xsd:string"/> <element name="customerid" nillable="true" type="xsd:string"/> </sequence> </complextype> </element> <element name="personalcustomermaintenance"> <complextype> <sequence> <element name="personalcustomermaintenanceinput" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="newpersonalcustomer"> <complextype> <sequence> <element name="newpersonalcustomerinput" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> 8

10 <element name="personalcustomerinquiryresponse"> <complextype> <sequence> <element name="personalcustomerinquiryreturn" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="personalcustomermaintenanceresponse"> <complextype> <sequence> <element name="personalcustomermaintenancereturn" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="newpersonalcustomerresponse"> <complextype> <sequence> <element name="newpersonalcustomerreturn" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="errorbean"> <complextype> <sequence> <element name="message" nillable="true" type="xsd:string" /> </sequence> </complextype> </element> </schema> </wsdl:types> <wsdl:message name="personalcustomerinquiryrequest"> <wsdl:part element="impl:personalcustomerinquiry" name="parameters" /> </wsdl:message> <wsdl:message name="personalcustomerinquiryresponse"> <wsdl:part element="impl:personalcustomerinquiryresponse" name="parameters" /> </wsdl:message> <wsdl:message name="personalcustomermaintenancerequest"> <wsdl:part element="impl:personalcustomermaintenance" name="parameters" /> </wsdl:message> <wsdl:message name="personalcustomermaintenanceresponse"> <wsdl:part element="impl:personalcustomermaintenanceresponse" name="parameters" /> </wsdl:message> <wsdl:message name="newpersonalcustomerrequest"> <wsdl:part element="impl:newpersonalcustomer" name="parameters" /> </wsdl:message> 9

11 <wsdl:message name="newpersonalcustomerresponse"> <wsdl:part element="impl:newpersonalcustomerresponse" name="parameters" /> </wsdl:message> <wsdl:message name="errormessage"> <wsdl:part name="validationerror" element="impl:errorbean"> </wsdl:part> </wsdl:message> <wsdl:porttype name="customerservices"> <wsdl:operation name="personalcustomerinquiry"> <wsdl:input message="impl:personalcustomerinquiryrequest" name="personalcustomerinquiryrequest" /> <wsdl:output message="impl:personalcustomerinquiryresponse" name="personalcustomerinquiryresponse" /> <wsdl:fault name="validationerror" message="impl:errormessage" /> </wsdl:operation> <wsdl:operation name="newpersonalcustomer"> <wsdl:input message="impl:newpersonalcustomerrequest" name="newpersonalcustomerrequest" /> <wsdl:output message="impl:newpersonalcustomerresponse" name="newpersonalcustomerresponse" /> <wsdl:fault name="validationerror" message="impl:errormessage" /> </wsdl:operation> <wsdl:operation name="personalcustomermaintenance"> <wsdl:input message="impl:personalcustomermaintenancerequest" name="personalcustomermaintenancerequest" /> <wsdl:output message="impl:personalcustomermaintenanceresponse" name="personalcustomermaintenanceresponse" /> <wsdl:fault name="validationerror" message="impl:errormessage" /> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="customerservicessoapbinding" type="impl:customerservices"> <wsdlsoap:binding style="document" transport=" /> <wsdl:operation name="personalcustomerinquiry"> <wsdlsoap:operation soapaction="" /> <wsdl:input name="personalcustomerinquiryrequest"> <wsdlsoap:body use="literal" /> </wsdl:input> <wsdl:output name="personalcustomerinquiryresponse"> <wsdlsoap:body use="literal" /> </wsdl:output> <wsdl:fault name="validationerror"> <wsdlsoap:fault name="validationerror" use="literal" /> </wsdl:fault> </wsdl:operation> 10

12 <wsdl:operation name="newpersonalcustomer"> <wsdlsoap:operation soapaction="" /> <wsdl:input name="newpersonalcustomerrequest"> <wsdlsoap:body use="literal" /> </wsdl:input> <wsdl:output name="newpersonalcustomerresponse"> <wsdlsoap:body use="literal" /> </wsdl:output> <wsdl:fault name="validationerror"> <wsdlsoap:fault name="validationerror" use="literal" /> </wsdl:fault> </wsdl:operation> <wsdl:operation name="personalcustomermaintenance"> <wsdlsoap:operation soapaction="" /> <wsdl:input name="personalcustomermaintenancerequest"> <wsdlsoap:body use="literal" /> </wsdl:input> <wsdl:output name="personalcustomermaintenanceresponse"> <wsdlsoap:body use="literal" /> </wsdl:output> <wsdl:fault name="validationerror"> <wsdlsoap:fault name="validationerror" use="literal" /> </wsdl:fault> </wsdl:operation> </wsdl:binding> <wsdl:service name="customerservice"> <wsdl:port binding="impl:customerservicessoapbinding" name="customerservices"> <wsdlsoap:address location=" /> </wsdl:port> </wsdl:service> </wsdl:definitions> 11

13 DOCUMENTACION DE ENTREGA SERVICIOS DE CLIENTES 1

14 Revisiones Fecha Versión Descripción Autor 11 de Agosto 1.0 Creación Catalina Sepúlveda 20 de Agosto Inclusión parámetro user en el Catalina Sepúlveda servicio. - Inclusión de detalle de clases. 11 de Septiembre Inclusión de campos descripción. - Descripción detallada de mensajes de error y campos con valores fijos. Catalina Sepúlveda 15 de Septiembre Inclusión de servicio de mantenimiento de clientes. Catalina Sepúlveda 10 de Octubre Inclusión nuevos campos al servicio. Catalina Sepúlveda 27 de Octubre Separación de servicio Nuevo y Mantenimiento. Catalina Sepúlveda 2

15 DOCUMENTACION DE ENTREGA SERVICIOS DE CLIENTES 1. DEPLOYMENT: NOMBRE TIPO FUNCION Axis2 WAR Web Services Engine customerservice AAR Deployment File 2. DEFINICION DE COMPONENTES: NOMBRE TIPO FUNCION customerservice.wsdl WSDL Web Service Description CustomerServiceSkeleton JAVA Class for service impl. EWS000001Message JAVA Message Class. EWS001001Message JAVA Message Class 3. RESUMEN DE METODOS FUNCIONALES personalcustomerinquiry: Servicio de consulta de clientes personales. Parámetros: o <user>- un tipo de dato String; envía el usuario que solicita la transacción. o <customerid>- un tipo de dato String; envía el numero de documento de identificación del cliente. Retorna: <PersonalCustMessage> - una estructura de datos compuesta con toda la data de cliente definida en el WSDL. Error: <Validation Error> - Estructura de mensaje de error usando un tipo de excepción errormessage definido en el WSDL. personalcustomermaintenance: Servicio de mantenimiento de clientes personales, se debe incluir el numero de cliente en el mensaje. Parámetros: <PersonalCustMessage> - una estructura de datos compuesta con toda la data de cliente definida en el WSDL. Retorna: <PersonalCustMessage> - una estructura de datos compuesta con toda la data de cliente definida en el WSDL. Error: <Validation Error> - Estructura de mensaje de error usando un tipo de excepción errormessage definido en el WSDL. newpersonalcustomer: Servicio de creación de cliente personal. El campo numero de cliente se debe enviar en ceros, el mensaje de respuesta debe retornar el nuevo numero de cliente generado. Parámetros: <PersonalCustMessage> - una estructura de datos compuesta con toda la data de cliente definida en el WSDL. 3

16 Retorna: <PersonalCustMessage> - una estructura de datos compuesta con toda la data de cliente definida en el WSDL. Error: <Validation Error> - Estructura de mensaje de error usando un tipo de excepción errormessage definido en el WSDL. El mensaje de error es un mensaje SOAP, sin embargo este mensaje se genera únicamente cuando se arroja una exception desde el método publicado. Esto quiere decir que en el cliente, el mensaje de error va a ser obtenido en un catch. Actualmente esta siendo enviado en un String con la forma: <código de error>-<descripción del error> Los códigos de error corresponden a los mismos códigos que se manejan en el e-ibs para las validaciones de formularios. Se adicionó la descripción de los campos que se parametrizan en tablas, algunos de los códigos corresponden a valores fijos, el detalle de estos valores se detalla en la siguiente tabla: CAMPO DETALLE legalstatus 1=Soltero(a), 2=Casado(a), 3=Divorciado(a), 4=Viudo(a), 5=otros Sex M=Masculino, F=Femenino relationtype 1 Cliente Regular 2 Especial 3 Empleado 4 Funcionario 5 Director 6 Pariente 7 Empresa Afiliada 8 Junta Directiva 8 Banco Corresponsal clientstatus 1=activo, 2=inactivo, 3=Lista negra clienttype 1=corporacion, 2=persona natural, 3=otros clientclass 1=Entidad Gubernamental, 2= ente descentralizado, N=No aplica language s=español e=ingles taxes Valores Fijos de 1 a 9 o N 4. FUNCIONALIDAD Para acceder a la funcionalidad de los web services se requiere construir un cliente partiendo del archivo WSDL que se adjunta en este entregable, el cliente del web service en este caso sería 4

17 Ultimus, quienes en su aplicación construirán el cliente del servicio e intercambiarán mensajes SOAP por HTTP con el servicio de Datapro que se encuentra publicado en el siguiente URL: Se puede obtener el WSDL a través del URL: A continuación presentamos un pequeño ejemplo del manejo de los mensajes SOAP: Firma del Metodo PersonalCustMessage personalcustomerinquiry(string customerid); Donde el tipo complejo PersonalCustMessage es definido como PersonalCustMessage { String firstname; String secondname; String phonenumber; todos los campos de respuesta } Request <?xml version="1.0" encoding="utf-8" standalone="no"?> <SOAP-ENV:Envelope SOAP- ENV:encodingStyle=" xmlns:soap-env=" xmlns:soap-enc=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:personalcustomerinquiry xmlns:ns1="urn:mysoapservices"> <user xsi:type="xsd:string">bptdatapro</user> <customerid xsi:type="xsd:string"> </customerid> </ns1:personalcustomerinquiry> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response <?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap-env=" <SOAP-ENV:Body> <ns1: personalcustomerinquiryresponse xmlns:ns1="urn:mysoapservices" SOAP- ENV:encodingStyle=" 5

18 <return xsi:type="ns1:personalcustmessage"> <firstname xsi:type="xsd:string">bill</firstname> <secondname xsi:type="xsd:string">gate</secondname> <phonenumber xsi:type="xsd:string"> </phonenumber> Todos los campos de respuesta </return> </ns1: personalcustomerinquiryresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Con el archivo WSDL se pueden generar los elementos necesarios en el cliente para acceder el servicio. 5. ANEXOS <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions targetnamespace=" xmlns:impl=" xmlns:intf=" xmlns:tns2=" xmlns:wsdl=" xmlns:wsdlsoap=" xmlns:xsd=" <wsdl:types> <schema elementformdefault="qualified" targetnamespace=" xmlns=" xmlns:impl=" xmlns:intf=" xmlns:wsdl=" xmlns:xsd=" <complextype name="personalcustmessage"> <sequence> <element name="user" nillable="true" type="xsd:string"/> <element name="idnumber" nillable="true" type="xsd:string"/> <element name="clienttype" nillable="true" type="xsd:string"/> <element name="idcountry" nillable="true" type="xsd:string"/> <element name="idtype" nillable="true" type="xsd:string"/> <element name="customernumber" nillable="true" type="xsd:string"/> <element name="firstname" nillable="true" type="xsd:string"/> <element name="secondname" nillable="true" type="xsd:string"/> <element name="firstlastname" nillable="true" type="xsd:string"/> <element name="secondlastname" nillable="true" type="xsd:string"/> <element name="marriedname" nillable="true" type="xsd:string"/> <element name="legalname" nillable="true" type="xsd:string"/> <element name="shortname" nillable="true" type="xsd:string"/> <element name="dependents" nillable="true" type="xsd:string"/> <element name="sex" nillable="true" type="xsd:string"/> <element name="legalstatus" nillable="true" type="xsd:string"/> <element name="nacionality" nillable="true" type="xsd:string"/> <element name="street" nillable="true" type="xsd:string"/> <element name="housenumber" nillable="true" type="xsd:string"/> <element name="province" nillable="true" type="xsd:string"/> <element name="distrit" nillable="true" type="xsd:string"/> <element name="correg" nillable="true" type="xsd:string"/> <element name="country" nillable="true" type="xsd:string"/> <element name="pobox" nillable="true" type="xsd:string"/> <element name="zipcode" nillable="true" type="xsd:string"/> <element name=" " nillable="true" type="xsd:string"/> 6 <element name="birthdate" nillable="true" type="xsd:string"/> <element name="firstcontactdate" nillable="true" type="xsd:string"/> <element name="housephonenum" nillable="true" type="xsd:string"/>

19 type="xsd:string"/> <element name="residencycountry" nillable="true" type="xsd:string"/> <element name="relationtype" nillable="true" type="xsd:string"/> <element name="educationlevel" nillable="true" type="xsd:string"/> <element name="profession" nillable="true" type="xsd:string"/> <element name="incomesource" nillable="true" type="xsd:string"/> <element name="risklevel" nillable="true" type="xsd:string"/> <element name="clientstatus" nillable="true" type="xsd:string"/> <element name="clientclass" nillable="true" type="xsd:string"/> <element name="groupnumber" nillable="true" type="xsd:string"/> <element name="language" nillable="true" type="xsd:string"/> <element name="taxes" nillable="true" type="xsd:string"/> <element name="referby" nillable="true" type="xsd:string"/> <element name="referbyn" nillable="true" type="xsd:string"/> <element name="familiarrelationtype" nillable="true" <element name="resident" nillable="true" type="xsd:string"/> <element name="inquirylevel" nillable="true" type="xsd:string"/> <element name="discountcompanyname" nillable="true" type="xsd:string"/> <element name="position" nillable="true" type="xsd:string"/> <element name="employmenttime" nillable="true" type="xsd:string"/> <element name="companytype" nillable="true" type="xsd:string"/> <element name="currentjentrydate" nillable="true" type="xsd:string"/> <element name="previusjentrydate" nillable="true" type="xsd:string"/> <element name="currentincome" nillable="true" type="xsd:string"/> <element name="perrefname1" nillable="true" type="xsd:string"/> <element name="perrefstreet1" nillable="true" type="xsd:string"/> <element name="perrefbuildnum1" nillable="true" type="xsd:string"/> <element name="perrefhousenum1" nillable="true" type="xsd:string"/> <element name="perrefprovince1" nillable="true" type="xsd:string"/> <element name="perrefdistrit1" nillable="true" type="xsd:string"/> <element name="perrefcorreg1" nillable="true" type="xsd:string"/> <element name="perrefcountry1" nillable="true" type="xsd:string"/> <element name="perrefpobox1" nillable="true" type="xsd:string"/> <element name="perrefzipcode1" nillable="true" type="xsd:string"/> <element name="perrefphonenum1" nillable="true" type="xsd:string"/> <element name="perrefname2" nillable="true" type="xsd:string"/> <element name="perrefstreet2" nillable="true" type="xsd:string"/> <element name="perrefbuildnum2" nillable="true" type="xsd:string"/> <element name="perrefhousenum2" nillable="true" type="xsd:string"/> <element name="perrefprovince2" nillable="true" type="xsd:string"/> <element name="perrefdistrit2" nillable="true" type="xsd:string"/> <element name="perrefcorreg2" nillable="true" type="xsd:string"/> <element name="perrefcountry2" nillable="true" type="xsd:string"/> <element name="perrefpobox2" nillable="true" type="xsd:string"/> <element name="perrefzipcode2" nillable="true" type="xsd:string"/> <element name="perrefphonenum2" nillable="true" type="xsd:string"/> <element name="countrydesc" nillable="true" type="xsd:string"/> <element name="idtypedesc" nillable="true" type="xsd:string"/> <element name="provincedesc" nillable="true" type="xsd:string"/> <element name="nacionalitydesc" nillable="true" type="xsd:string"/> <element name="distritdesc" nillable="true" type="xsd:string"/> <element name="corregdesc" nillable="true" type="xsd:string"/> <element name="mainofficerdesc" nillable="true" type="xsd:string"/> <element name="secondofficerdesc" nillable="true" type="xsd:string"/> <element name="industrycodedesc" nillable="true" type="xsd:string"/> 7

20 <element name="mainofficerdesc" nillable="true" type="xsd:string"/> <element name="secondofficerdesc" nillable="true" type="xsd:string"/> <element name="industrycodedesc" nillable="true" type="xsd:string"/> <element name="bussinescodedesc" nillable="true" type="xsd:string"/> <element name="residencycountrydesc" nillable="true" type="xsd:string"/> <element name="educationleveldsc" nillable="true" type="xsd:string"/> <element name="professiondesc" nillable="true" type="xsd:string"/> <element name="incomesourcedsc" nillable="true" type="xsd:string"/> <element name="riskleveldsc" nillable="true" type="xsd:string"/> <element name="companynamedsc" nillable="true" type="xsd:string"/> <element name="positiondsc" nillable="true" type="xsd:string"/> <element name="perrefprovince1dsc" nillable="true" type="xsd:string"/> <element name="perrefdistrit1dsc" nillable="true" type="xsd:string"/> <element name="perrefcorreg1dsc" nillable="true" type="xsd:string"/> <element name="perrefprovince2dsc" nillable="true" type="xsd:string"/> <element name="perrefdistrit2dsc" nillable="true" type="xsd:string"/> <element name="perrefcorreg2dsc" nillable="true" type="xsd:string"/> <element name="referbydsc" nillable="true" type="xsd:string"/> <element name="companyname" nillable="true" type="xsd:string"/> <element name="companyaddress" nillable="true" type="xsd:string"/> <element name="companyinfo" nillable="true" type="xsd:string"/> </sequence> </complextype> </schema> <schema elementformdefault="qualified" targetnamespace=" xmlns=" xmlns:impl=" xmlns:intf=" xmlns:tns2=" xmlns:wsdl=" xmlns:xsd=" <import namespace=" /> <element name="personalcustomerinquiry"> <complextype> <sequence> <element name="user" nillable="true" type="xsd:string"/> <element name="customerid" nillable="true" type="xsd:string"/> </sequence> </complextype> </element> <element name="personalcustomermaintenance"> <complextype> <sequence> <element name="personalcustomermaintenanceinput" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="newpersonalcustomer"> <complextype> <sequence> <element name="newpersonalcustomerinput" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> 8

21 <element name="personalcustomerinquiryresponse"> <complextype> <sequence> <element name="personalcustomerinquiryreturn" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="personalcustomermaintenanceresponse"> <complextype> <sequence> <element name="personalcustomermaintenancereturn" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="newpersonalcustomerresponse"> <complextype> <sequence> <element name="newpersonalcustomerreturn" nillable="true" type="tns2:personalcustmessage" /> </sequence> </complextype> </element> <element name="errorbean"> <complextype> <sequence> <element name="message" nillable="true" type="xsd:string" /> </sequence> </complextype> </element> </schema> </wsdl:types> <wsdl:message name="personalcustomerinquiryrequest"> <wsdl:part element="impl:personalcustomerinquiry" name="parameters" /> </wsdl:message> <wsdl:message name="personalcustomerinquiryresponse"> <wsdl:part element="impl:personalcustomerinquiryresponse" name="parameters" /> </wsdl:message> <wsdl:message name="personalcustomermaintenancerequest"> <wsdl:part element="impl:personalcustomermaintenance" name="parameters" /> </wsdl:message> <wsdl:message name="personalcustomermaintenanceresponse"> <wsdl:part element="impl:personalcustomermaintenanceresponse" name="parameters" /> </wsdl:message> <wsdl:message name="newpersonalcustomerrequest"> <wsdl:part element="impl:newpersonalcustomer" name="parameters" /> </wsdl:message> 9

22 <wsdl:message name="newpersonalcustomerresponse"> <wsdl:part element="impl:newpersonalcustomerresponse" name="parameters" /> </wsdl:message> <wsdl:message name="errormessage"> <wsdl:part name="validationerror" element="impl:errorbean"> </wsdl:part> </wsdl:message> <wsdl:porttype name="customerservices"> <wsdl:operation name="personalcustomerinquiry"> <wsdl:input message="impl:personalcustomerinquiryrequest" name="personalcustomerinquiryrequest" /> <wsdl:output message="impl:personalcustomerinquiryresponse" name="personalcustomerinquiryresponse" /> <wsdl:fault name="validationerror" message="impl:errormessage" /> </wsdl:operation> <wsdl:operation name="newpersonalcustomer"> <wsdl:input message="impl:newpersonalcustomerrequest" name="newpersonalcustomerrequest" /> <wsdl:output message="impl:newpersonalcustomerresponse" name="newpersonalcustomerresponse" /> <wsdl:fault name="validationerror" message="impl:errormessage" /> </wsdl:operation> <wsdl:operation name="personalcustomermaintenance"> <wsdl:input message="impl:personalcustomermaintenancerequest" name="personalcustomermaintenancerequest" /> <wsdl:output message="impl:personalcustomermaintenanceresponse" name="personalcustomermaintenanceresponse" /> <wsdl:fault name="validationerror" message="impl:errormessage" /> </wsdl:operation> </wsdl:porttype> <wsdl:binding name="customerservicessoapbinding" type="impl:customerservices"> <wsdlsoap:binding style="document" transport=" /> <wsdl:operation name="personalcustomerinquiry"> <wsdlsoap:operation soapaction="" /> <wsdl:input name="personalcustomerinquiryrequest"> <wsdlsoap:body use="literal" /> </wsdl:input> <wsdl:output name="personalcustomerinquiryresponse"> <wsdlsoap:body use="literal" /> </wsdl:output> <wsdl:fault name="validationerror"> <wsdlsoap:fault name="validationerror" use="literal" /> </wsdl:fault> </wsdl:operation> 10

23 <wsdl:operation name="newpersonalcustomer"> <wsdlsoap:operation soapaction="" /> <wsdl:input name="newpersonalcustomerrequest"> <wsdlsoap:body use="literal" /> </wsdl:input> <wsdl:output name="newpersonalcustomerresponse"> <wsdlsoap:body use="literal" /> </wsdl:output> <wsdl:fault name="validationerror"> <wsdlsoap:fault name="validationerror" use="literal" /> </wsdl:fault> </wsdl:operation> <wsdl:operation name="personalcustomermaintenance"> <wsdlsoap:operation soapaction="" /> <wsdl:input name="personalcustomermaintenancerequest"> <wsdlsoap:body use="literal" /> </wsdl:input> <wsdl:output name="personalcustomermaintenanceresponse"> <wsdlsoap:body use="literal" /> </wsdl:output> <wsdl:fault name="validationerror"> <wsdlsoap:fault name="validationerror" use="literal" /> </wsdl:fault> </wsdl:operation> </wsdl:binding> <wsdl:service name="customerservice"> <wsdl:port binding="impl:customerservicessoapbinding" name="customerservices"> <wsdlsoap:address location=" /> </wsdl:port> </wsdl:service> </wsdl:definitions> 11

24 DOCUMENTACION SERVICIOS DE PAGOS DE TARJETAS DE CREDITO 1

25 Revisiones Fecha Versión Descripción Autor 20 Abril Creación de Documentación Catalina Sepúlveda 2

26 DOCUMENTACION SERVICIOS DE PAGOS CON TARJETAS DE CREDITO 1. DEFINICION DE COMPONENTES: NOMBRE TIPO FUNCION CreditCardPayment.wsdl WSDL Web Service Description 2. RESUMEN DE METODOS FUNCIONALES getvalidaccountavailable: Servicio de consulta te cuenta disponible para pago. Parámetros: o < ACCOUNT> - String. Número de Cuenta. o <CREDITCARD>- String. Número de Tarjeta de Crédito o <REFERENCE> - String. Referencia del Pago o <AMOUNT> - String. Monto del Pago Retorna: o < ERRORCODE> - String. Retorna un código de error si existe error, retorna 0 si no hay error. o <ERRORDSC>- String. Descripción del error si existe error. o <REFERENCE> - String. Referencia del Pago aplicado, si hubo error retorna 0. setcreditcardpayment: Servicio de creación del pago sobre la tarjeta. Parámetros: o < ACCOUNT> - String. Número de Cuenta. o <CREDITCARD>- String. Número de Tarjeta de Crédito o <REFERENCE> - String. Referencia del Pago o <AMOUNT> - String. Monto del Pago Retorna: o < ERRORCODE> - String. Retorna un código de error si existe error, retorna 0 si no hay error. o <ERRORDSC>- String. Descripción del error si existe error. o <REFERENCE> - String. Referencia del Pago aplicado, si hubo error retorna 0. 3

27 3. FUNCIONALIDAD Para acceder a la funcionalidad de los web services se requiere construir un cliente partiendo del archivo WSDL que se adjunta en este entregable, el cliente del web service en este caso sería Ultimus, quienes en su aplicación construirán el cliente del servicio e intercambiarán mensajes SOAP por HTTP con el servicio de Datapro que se encuentra publicado en el siguiente URL: Se puede obtener el WSDL a través del URL: A continuación presentamos un pequeño ejemplo del manejo de los mensajes SOAP: Firma del Metodo PersonalCustMessage personalcustomerinquiry(string customerid); Donde el tipo complejo PersonalCustMessage es definido como PersonalCustMessage { String firstname; String secondname; String phonenumber; todos los campos de respuesta } Request <?xml version="1.0" encoding="utf-8" standalone="no"?> <SOAP-ENV:Envelope SOAP- ENV:encodingStyle=" xmlns:soap-env=" xmlns:soap-enc=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:personalcustomerinquiry xmlns:ns1="urn:mysoapservices"> <user xsi:type="xsd:string">bptdatapro</user> <customerid xsi:type="xsd:string"> </customerid> </ns1:personalcustomerinquiry> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response <?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:xsi=" 4

28 xmlns:xsd=" xmlns:soap-env=" <SOAP-ENV:Body> <ns1: personalcustomerinquiryresponse xmlns:ns1="urn:mysoapservices" SOAP- ENV:encodingStyle=" <return xsi:type="ns1:personalcustmessage"> <firstname xsi:type="xsd:string">bill</firstname> <secondname xsi:type="xsd:string">gate</secondname> <phonenumber xsi:type="xsd:string"> </phonenumber> Todos los campos de respuesta </return> </ns1: personalcustomerinquiryresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Con el archivo WSDL se pueden generar los elementos necesarios en el cliente para acceder el servicio. 5

29 DOCUMENTACION DE ENTREGA SERVICIOS DE CUENTAS 1

30 Revisiones Fecha Versión Descripción Autor 31 de Octubre 1.0 Creación Catalina Sepúlveda 2

31 DOCUMENTACION DE ENTREGA SERVICIOS DE CUENTAS 1. DEPLOYMENT: NOMBRE TIPO FUNCION Axis2 WAR Web Services Engine accountservice AAR Deployment File 2. DEFINICION DE COMPONENTES: NOMBRE TIPO FUNCION accountservice.wsdl WSDL Web Service Description AccountServiceSkeleton JAVA Class for service impl. EWS002001Message JAVA Message Class. 3. RESUMEN DE METODOS FUNCIONALES newaccount: Servicio de creación de cuenta corriente. Parámetros: <AccountsMessage>- una estructura de datos compuesta con toda la data de cuenta definida en el WSDL. Retorna: <AccountsMessage> - una estructura de datos compuesta con toda la data de cuenta definida en el WSDL. Error: <Validation Error> - Estructura de mensaje de error usando un tipo de excepción errormessage definido en el WSDL. El mensaje de error es un mensaje SOAP, sin embargo este mensaje se genera únicamente cuando se arroja una exception desde el método publicado. Esto quiere decir que en el cliente, el mensaje de error va a ser obtenido en un catch. Actualmente esta siendo enviado en un String con la forma: <código de error>-<descripción del error> Los códigos de error corresponden a los mismos códigos que se manejan en el e-ibs para las validaciones de formularios. NOMBRE DEL CAMPO taxeswitholdingflag VALORES 1 =Retención sobre Intereses ISR 2=Cobre del IVA 3 = IVA mas ISR 4 = IVA solo en Comisiones 5= IVA solo en Intereses 6 = Debito Bancario IDB 7 = IDB mas ISR 8 = IDB mas IVA 9 = Todo tipo de Impuesto 3

32 servicechargesflag overdraftschargesflag overdraftfrecuency accountstatementtype checkingchargesflag interestpaymentflag mailingaddress N = No calcula Impuestos F = Cobro del FECI Y/N Y/N "D" =Diario "W" =Semanal "B" =Quincenal "M" selected=mensual "Q" =Trimestral "P" =Personal "C" =Corporativa "N" =Ninguna Y/N Y/N Y/N 4. FUNCIONALIDAD Para acceder a la funcionalidad de los web services se requiere construir un cliente partiendo del archivo WSDL que se adjunta en este entregable, el cliente del web service en este caso sería Ultimus, quienes en su aplicación construirán el cliente del servicio e intercambiarán mensajes SOAP por HTTP con el servicio de Datapro que se encuentra publicado en el siguiente URL: Se puede obtener el WSDL a través del URL: A continuación presentamos un pequeño ejemplo del manejo de los mensajes SOAP: Firma del Metodo PersonalCustMessage personalcustomerinquiry(string customerid); Donde el tipo complejo PersonalCustMessage es definido como PersonalCustMessage { String firstname; String secondname; String phonenumber; todos los campos de respuesta } Request <?xml version="1.0" encoding="utf-8" standalone="no"?> <SOAP-ENV:Envelope SOAP- ENV:encodingStyle=" xmlns:soap-env=" 4

33 xmlns:soap-enc=" xmlns:xsi=" xmlns:xsd=" <SOAP-ENV:Body> <ns1:personalcustomerinquiry xmlns:ns1="urn:mysoapservices"> <user xsi:type="xsd:string">bptdatapro</user> <customerid xsi:type="xsd:string"> </customerid> </ns1:personalcustomerinquiry> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response <?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap-env=" <SOAP-ENV:Body> <ns1: personalcustomerinquiryresponse xmlns:ns1="urn:mysoapservices" SOAP- ENV:encodingStyle=" <return xsi:type="ns1:personalcustmessage"> <firstname xsi:type="xsd:string">bill</firstname> <secondname xsi:type="xsd:string">gate</secondname> <phonenumber xsi:type="xsd:string"> </phonenumber> Todos los campos de respuesta </return> </ns1: personalcustomerinquiryresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Con el archivo WSDL se pueden generar los elementos necesarios en el cliente para acceder el servicio. 5. ANEXOS <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions targetnamespace=" xmlns:impl=" xmlns:intf=" xmlns:tns2=" xmlns:wsdl=" xmlns:wsdlsoap=" xmlns:xsd=" <wsdl:types> <schema elementformdefault="qualified" targetnamespace=" xmlns=" xmlns:impl=" xmlns:intf=" xmlns:wsdl=" xmlns:xsd=" <complextype name="accountsmessage"> <sequence> 5

34 <element name="user" nillable="true" type="xsd:string"/> <element name="accountnumber" nillable="true" type="xsd:string"/> <element name="customernumber" nillable="true" type="xsd:string"/> <element name="customerid" nillable="true" type="xsd:string"/> <element name="productcode" nillable="true" type="xsd:string"/> <element name="bank" nillable="true" type="xsd:string"/> <element name="currency" nillable="true" type="xsd:string"/> <element name="branch" nillable="true" type="xsd:string"/> <element name="glaccount" nillable="true" type="xsd:string"/> <element name="customername" nillable="true" type="xsd:string"/> <element name="accounttype" nillable="true" type="xsd:string"/> <element name="accounttypedesc" nillable="true" type="xsd:string"/> <element name="productcodedesc" nillable="true" type="xsd:string"/> <element name="appcode" nillable="true" type="xsd:string"/> <element name="officialcode" nillable="true" type="xsd:string"/> <element name="costcenter" nillable="true" type="xsd:string"/> <element name="openingdate" nillable="true" type="xsd:string"/> <element name="tarifftable" nillable="true" type="xsd:string"/> <element name="usercode1" nillable="true" type="xsd:string"/> <element name="usercode2" nillable="true" type="xsd:string"/> <element name="usercode3" nillable="true" type="xsd:string"/> <element name="usercode4" nillable="true" type="xsd:string"/> <element name="taxeswitholdingflag" nillable="true" type="xsd:string"/> <element name="checkingtype" nillable="true" type="xsd:string"/> <element name="minimumcheckingstock" nillable="true" type="xsd:string"/> <element name="servicechargesflag" nillable="true" type="xsd:string"/> <element name="overdraftschargesflag" nillable="true" type="xsd:string"/> <element name="overdraftamountused" nillable="true" type="xsd:string"/> <element name="overdraftfrecuency" nillable="true" type="xsd:string"/> <element name="chargespaymentday" nillable="true" type="xsd:string"/> <element name="accountstatementretentionflag" nillable="true" type="xsd:string"/> <element name="accountstatementfrecuency" nillable="true" type="xsd:string"/> <element name="accountstatementprintingday" nillable="true" type="xsd:string"/> <element name="accountstatementtype" nillable="true" type="xsd:string"/> <element name="consolidatedstatementflag" nillable="true" type="xsd:string"/> <element name="dailystatementaccountvia" nillable="true" type="xsd:string"/> <element name="clientlinmultiuse" nillable="true" type="xsd:string"/> <element name="clientlinnumber" nillable="true" type="xsd:string"/> <element name="sendingchannel" nillable="true" type="xsd:string"/> <element name="personalizationcheck1" nillable="true" type="xsd:string"/> <element name="personalizationcheck2" nillable="true" type="xsd:string"/> <element name="checkingchargesflag" nillable="true" type="xsd:string"/> <element name="checkingchargesrestriction" nillable="true" type="xsd:string"/> <element name="interestpaymentflag" nillable="true" type="xsd:string"/> <element name="accountstatus" nillable="true" type="xsd:string"/> <element name="mailingaddress" nillable="true" type="xsd:string"/> <element name="creditlinenumber" nillable="true" type="xsd:string"/> <element name="creditlinetype" nillable="true" type="xsd:string"/> </sequence> </complextype> </schema> <schema elementformdefault="qualified" targetnamespace=" xmlns=" xmlns:impl=" xmlns:intf=" xmlns:tns2=" xmlns:wsdl=" xmlns:xsd=" 6