ANEXO TECNICO WEB DE SERVICE FUNCIONALES INVESDOC GALLERY SUITE ECOLLECT

Transcripción

1 ANEXO TECNICO WEB DE SERVICE FUNCIONALES INVESDOC GALLERY SUITE ECOLLECT

2 3. SERVICIOS WEB 3.1 Servici Ofrecids en el mdul de Invesdc Acces La URL para acceder a ls servicis web es: WSDL: Obtener Seccinales Permite la cnsulta de las seccinales que están registradas en la base de dats Servici getseccinales Parámetrs de cnsulta Nmbre Descripción Tip Observacines cdig Cdig de la Seccinal Numeric Opcinal Resultad de la cnsulta Nmbre Descripción Tip Observacines cdig Cdig de la seccinal Numeric Se repite pr cada seccinal que se nmbre Nmbre de la seccinal Alfanum eric retrna en la cnsulta iddepartament Identificadr del departament de la Numeric estructura de usuaris al que pertenece la seccinal Obtener Institucines Permite la cnsulta de las institucines educativas que están registradas en la base de dats Servici getinstitucines Parámetrs de cnsulta Nmbre Descripción Tip Observacines Resultad de la cnsulta Nmbre Descripción Tip Observacines cdig Cdig de la universidad Numeric Se repite pr cada universidad que se nmbre Nmbre de la universidad Alfanum retrna en la cnsulta [Pág. 6 de 31]

3 eric Obtener Prfesines Permite la cnsulta de las institucines educativas que están registradas en la base de dats Servici getprfesines Parámetrs de cnsulta Nmbre Descripción Tip Observacines institucin Códig de la institución de la que se Numeric Opcinal desean las prfesines Resultad de la cnsulta Nmbre Descripción Tip Observacines cdig Cdig de la prfesión Numeric Se repite pr cada prfesin que se nmbre Nmbre de la prfesión Alfanum eric retrna en la cnsulta Obtener Egresad Permite la cnsulta de la infrmación de un Egresad Servici getegresad Parámetrs de cnsulta Nmbre Descripción Tip Observacines tipidentificaci Tip de identificación Alfanum CC, CE n identificacin Númer de identificación Numéric Opcinal Resultad de la cnsulta Nmbre Descripción Tip Observacines tipidentificaci n Tip de identificación del Egresad Alfanum eric identificacin Identificación del Egresad Alfanum eric nmbre Nmbre del Egresad Alfanum eric apellids Apellids del Egresad Alfanum eric fechagrad Fecha de Grad Fecha institucin Dats de la institución Cmpue st listadegresad Infrmación del listad dnde Cmpue aparece el Egresad st numactagrad Númer de acta Alfanum eric numlibrfli RegTitul Númer de Libr/Fli dnde está registrad el titul Alfanum eric [Pág. 7 de 31]

4 numudp Númer de Unidad Dcumental Alfanum eric prfesin Dats de la prfesin Cmpue st seccinaludp Dats de la seccinal de la Unidad Dcumental Cmpue st Dats de la institución cdig Cdig de la institución Numéric nmbre Nmbre de la institución Alfanum Dats del listad del Egresad Fecha Fecha Fli Alfanum Identificadr Alfanum seccinal Dats de la seccinal Cmpue st Ubicación Alfanum Alfanum unidaddcume ntal Universidad Dats de la Universidad Cmpue st Dats de la seccinal cdig Cdig de la seccinal Numeric nmbre Nmbre de la seccinal Alfanum eric iddepartament Identificadr del departament en Invesdc Numeric Dats de la Universidad cdig Cdig de la universidad Numeric nmbre Nmbre de la universidad Alfanum eric Dats de la Prfesin cdig Cdig de la prfesión Numeric nmbre Nmbre de la prfesión Alfanum eric Dats de Seccinal 3.2 Servici Ofrecids en el mdul de Invesflw Acces La URL para acceder a ls servicis web es: [Pág. 8 de 31]

5 WSDL: Obtener infrmación de Entidades A cntinuación se explica cóm acceder a la infrmación de ls dats de determinadas entidades que se encuentran cargadas en la base de dats de invesflw. Para pder acceder a ls dats de una entidad se requiere cncer el expediente desde el cual se cargarn dichs dats Obtener Pags Permite la cnsulta de ls dats de pags cargads a través del prcedimient de Acreedres Servici btenerregistrsentidad Parámetrs de cnsulta Nmbre Descripción Tip Observacines nmbreentidad Nmbre de la entidad que cntiene Alfanum Valr: IVF_PAGOS ls dats numexp Númer de expediente Alfanum Resultad de la cnsulta Nmbre Descripción Tip Observacines errrcde Códig de errr Numeric returncde Códig de resultad Alfanum eric valr Resultad de la cnsulta, en XML Alfanum eric Ejempl Petición Resultad <sapenv:envelpe xmlns:sapenv=" xmlns:ser=" <sapenv:header/> <sapenv:bdy> <ser:btenerregistrsentidad> <ser:nmbreentidad>ivf_pagos</ser:nmbreentidad> <ser:numexp>exp2013/000539</ser:numexp> </ser:btenerregistrsentidad> </sapenv:bdy> </sapenv:envelpe> <sapenv:envelpe xmlns:sapenv=" xmlns:xsd=" xmlns:xsi=" <sapenv:bdy> <btenerregistrsentidadrespnse xmlns=" <btenerregistrsentidad> <errrcde xsi:nil="true"/> <returncde>ok</returncde> <valr><![cdata[<?xml versin='1.0' encding='iso '?><results> <item><value name='id'><![cdata[425]]]]>><![cdata[</value><value [Pág. 9 de 31]

6 name='numexp'><![cdata[exp2013/000539]]]]>><![cdata[</value><value name='fecha_registro'><![cdata[04/12/2013]]]]>><![cdata[</value><value name='id_pago'><![cdata[ ]]]]>><![cdata[</value><value name='valor_recaudado'><![cdata[ ]]]]>><![cdata[</value><value name='fecha_pago'><![cdata[01/08/2013]]]]>><![cdata[</value><value name='entidad_bancaria'><![cdata[]]]]>><![cdata[</value><value name='cod_entidad_bancaria'><![cdata[999]]]]>><![cdata[</value><value name='id_transaccion'><![cdata[000000]]]]>><![cdata[</value><value name='id_documento'><![cdata[1265]]]]>><![cdata[</value><value name='finalizado'><![cdata[si]]]]>><![cdata[</value></item> <item><value name='id'><![cdata[426]]]]>><![cdata[</value><value name='numexp'><![cdata[exp2013/000539]]]]>><![cdata[</value><value name='fecha_registro'><![cdata[04/12/2013]]]]>><![cdata[</value><value name='id_pago'><![cdata[ ]]]]>><![cdata[</value><value name='valor_recaudado'><![cdata[ ]]]]>><![cdata[</value><value name='fecha_pago'><![cdata[01/08/2013]]]]>><![cdata[</value><value name='entidad_bancaria'><![cdata[]]]]>><![cdata[</value><value name='cod_entidad_bancaria'><![cdata[999]]]]>><![cdata[</value><value name='id_transaccion'><![cdata[000000]]]]>><![cdata[</value><value name='id_documento'><![cdata[1265]]]]>><![cdata[</value><value name='finalizado'><![cdata[no]]]]>><![cdata[</value></item> <item><value name='id'><![cdata[427]]]]>><![cdata[</value><value name='numexp'><![cdata[exp2013/000539]]]]>><![cdata[</value><value name='fecha_registro'><![cdata[04/12/2013]]]]>><![cdata[</value><value name='id_pago'><![cdata[ ]]]]>><![cdata[</value><value name='valor_recaudado'><![cdata[ ]]]]>><![cdata[</value><value name='fecha_pago'><![cdata[01/08/2013]]]]>><![cdata[</value><value name='entidad_bancaria'><![cdata[]]]]>><![cdata[</value><value name='cod_entidad_bancaria'><![cdata[999]]]]>><![cdata[</value><value name='id_transaccion'><![cdata[000000]]]]>><![cdata[</value><value name='id_documento'><![cdata[1265]]]]>><![cdata[</value><value name='finalizado'><![cdata[si]]]]>><![cdata[</value></item> </results>]]></valr> </btenerregistrsentidad> </btenerregistrsentidadrespnse> </sapenv:bdy> </sapenv:envelpe> 3.3 Servici Ofrecids en el mdul de ISicres (Crrespndencia) Acces La URL para acceder a ls servicis web es: WSDL: Para pder acceder a ls servicis de ISicres se maneja dentr de la petición del servici web ls dats de autrización para el usuari cn Tken de Seguridad, cm se indica a cntinuación: [Pág. 10 de 31]

7 Nmbre Descripción Tip Observacines Security Cntiene la infrmación de Cmpuest seguridad para el acces UsernameTken Cntiene dats de Cmpuest seguridad Username Nmbre de Usuari Alfanumeric Valr: web Passwrd Passwrd Alfanumeric Valr: OfficeCde Cdig de ficina Alfanumeric Valr: 01 CheckPermissins Validar permiss Numeric Valr: Obtener infrmación de registrs de crrespndencia de Entrada A cntinuación se explica cóm acceder a la infrmación de ls dats de ls registrs de crrespndencia de Entrada. Servici WSLadInputRegisters Parámetrs de cnsulta Nmbre Descripción Tip Observacines Security Tken de Seguridad Cmpue st BkIdentificatin Id del libr de crrespndencia Alfanum Valr: 1 Cnditin Númer de expediente Alfanum Sentencias SQL para traer dats, Ver Nta 1 InitValue Rang inicial Numéric Valr: 1 Size Cantidad de registrs a Numéric cnsultar Resultad de la cnsulta Nmbre Descripción Tip Observacines WSInputRegister Cmpue st State Estad Numéric FlderId Id del Registr Numéric BkId Id del Libr Numéric Number Numer del registr Alfanum Date Fecha del registr Fecha UserName Usuari Alfanum SystemDate Fecha de trabaj Fecha Office Códig de ficina Alfanum OfficeName Nmbre de ficina Alfanum Este dat se repite de acuerd a la cantidad de resultads de la búsqueda. [Pág. 11 de 31]

8 Destinatin Códig del destin Alfanum DestinatinName Nmbre del destin Alfanum MatterType Códig del Tip de Asunt Alfanum MatterTypeName Nmbre del Tip de Asunt Alfanum Matter Resumen Alfanum Persns Infrmación del remitente Cmpue st Id Identificadr remitente Alfanum Name Nmbre del remitente Alfanum Dcuments Dcuments Cmpue st WSDcument Dcument Cmpue st Id Identificadr del dcument Alfanum Name Nmbre del dcument Alfanum Pages Paginas / Archivs Cmpue st WSPage Pagina / Archiv Cmpue st Id Identificadr Numeric Name Nmbre del Archiv Alfanum Lcatr Alfanum AddFields Camps adicinales Cmpue st WSAddField Camp adicinal Cmpue Ejempl Petición st FieldId Id del camp Numéric Value Valr del camp Alfanum Ver Nta 2 <sapenv:envelpe xmlns:sapenv=" xmlns:sec=" xmlns:inv=" <sapenv:header> <sec:security> <sec:usernametken> <sec:username>pqr@cpnia.gv.c</sec:username> <sec:passwrd>12345</sec:passwrd> <sec:officecde>nal</sec:officecde> <sec:checkpermissins>1</sec:checkpermissins> [Pág. 12 de 31]

9 Resultad </sec:usernametken> </sec:security> </sapenv:header> <sapenv:bdy> <inv:wsladinputregisters> <inv:bkidentificatin>1</inv:bkidentificatin> <inv:cnditin>fld1 = '2014WEB '</inv:Cnditin> <inv:initvalue>1</inv:initvalue> <inv:size>100</inv:size> </inv:wsladinputregisters> </sapenv:bdy> </sapenv:envelpe> <sap:envelpe xmlns:sap=" <sap:bdy> <WSLadInputRegistersRespnse xmlns:ns2=" xmlns=" <WSLadInputRegistersResult Ttal="1"> <List> <WSInputRegister State="0" FlderId="699" BkId="1"> <Number>2014WEB </Number> <Date> T02:14: :00</Date> <UserName>web</UserName> <SystemDate> T02:14: :00</SystemDate> <Office>WEB</Office> <OfficeName>OFICINA DE REGISTRO TELEMÁTICO</OfficeName> <Destinatin>001</Destinatin> <DestinatinName>COPNIA</DestinatinName> <MatterType>PET-CONSVER</MatterType> <MatterTypeName>Peticines - Cnsulta Verificación de Registr</MatterTypeName> <Matter>Petición, Queja, Reclam Sugerencia</Matter> <Persns> <WSPersn Id="1804"> <Name>Alfns Suarez Alicia Maria</Name> </WSPersn> </Persns> <Dcuments> <WSDcument Id="992"> <Name>Justificante de Registr</Name> <Pages> <WSPage Id="1"> <Name>Justificante de Registr.pdf</Name> <Lcatr>4501</Lcatr> </WSPage> </Pages> </WSDcument> <WSDcument Id="993"> <Name>Slicitud de Registr</Name> <Pages> <WSPage Id="2"> <Name>Slicitud de Registr.xml</Name> <Lcatr>4502</Lcatr> </WSPage> [Pág. 13 de 31]

10 </Pages> </WSDcument> </Dcuments> <AddFields> <WSAddField> <FieldId>18</FieldId> </WSAddField> <WSAddField> <FieldId>500</FieldId> </WSAddField> <WSAddField> <FieldId>1000</FieldId> </WSAddField> <WSAddField> <FieldId>19</FieldId> </WSAddField> <WSAddField> <FieldId>20</FieldId> </WSAddField> <WSAddField> <FieldId>1001</FieldId> <Value>N</Value> </WSAddField> <WSAddField> <FieldId>1002</FieldId> </WSAddField> </AddFields> </WSInputRegister> </List> </WSLadInputRegistersResult> </WSLadInputRegistersRespnse> </sap:bdy> </sap:envelpe> Nta 1: Camp Cnditin: Clumnas Dispnibles: Fld1: Numer de Registr Fld2: Fecha de Registr Ejempl: Fld1 = '2014WEB ' Fld2 >= '01/03/2014 Fld2 >= '01/03/2014' AND Fld2 <= '08/04/2014' Nta 2: Camp FieldId 18: Cmentaris 500: LimiteInferirReserva 1000: LimiteSuperirReserva 1001: Distribuid 1002: ID_ [Pág. 14 de 31]

11 3.3.3 Obtener infrmación de registrs de crrespndencia de Salida A cntinuación se explica cóm acceder a la infrmación de ls dats de ls registrs de crrespndencia de Salida Servici WSLadOutputRegisters Parámetrs de cnsulta Nmbre Descripción Tip Observacines Security Tken de Seguridad Cmpue st BkIdentificatin Id del libr de crrespndencia Alfanum Valr: 2 Cnditin Númer de expediente Alfanum Sentencias SQL para traer dats, Ver Nta 1 InitValue Rang inicial Numéric Valr: 1 Size Cantidad de registrs a Numéric cnsultar Resultad de la cnsulta Nmbre Descripción Tip Observacines WSOutputRegister Cmpue st State Estad Numéric FlderId Id del Registr Numéric BkId Id del Libr Numéric Number Numer del registr Alfanum Date Fecha del registr Fecha UserName Usuari Alfanum SystemDate Fecha de trabaj Fecha Office Códig de ficina Alfanum OfficeName Nmbre de ficina Alfanum Sender Códig del destin Alfanum SenderName Nmbre del destin Alfanum MatterType Códig del Tip de Asunt Alfanum MatterTypeName Nmbre del Tip de Asunt Alfanum Matter Resumen Alfanum Persns Infrmación del Cmpue Este dat se repite de acuerd a la cantidad de resultads de la búsqueda. [Pág. 15 de 31]

12 remitente st Id Identificadr remitente Alfanum Name Nmbre del remitente Alfanum Dcuments Dcuments Cmpue st WSDcument Dcument Cmpue st Id Identificadr del dcument Alfanum Name Nmbre del dcument Alfanum Pages Paginas / Archivs Cmpue st WSPage Pagina / Archiv Cmpue st Id Identificadr Numeric Name Nmbre del Archiv Alfanum Lcatr Alfanum AddFields Camps adicinales Cmpue st WSAddField Camp adicinal Cmpue Ejempl Petición st FieldId Id del camp Numéric Value Valr del camp Alfanum Ver Nta 2 <sapenv:envelpe xmlns:sapenv=" xmlns:sec=" xmlns:inv=" <sapenv:header> <sec:security> <sec:usernametken> <sec:username>pqr@cpnia.gv.c</sec:username> <sec:passwrd>12345</sec:passwrd> <sec:officecde>nal</sec:officecde> <sec:checkpermissins>1</sec:checkpermissins> </sec:usernametken> </sec:security> </sapenv:header> <sapenv:bdy> <inv:wsladoutputregisters> <inv:bkidentificatin>2</inv:bkidentificatin> <inv:cnditin>fld2 >= '01/01/2014' </inv:cnditin> <inv:initvalue>1</inv:initvalue> <inv:size>100</inv:size> </inv:wsladoutputregisters> </sapenv:bdy> [Pág. 16 de 31]

13 Resultad </sapenv:envelpe> <sap:envelpe xmlns:sap=" <sap:bdy> <WSLadOutputRegistersRespnse xmlns:ns2=" xmlns=" <WSLadOutputRegistersResult Ttal="1"> <List> <WSOutputRegister State="0" FlderId="183" BkId="2"> <Number>2014ANT </Number> <Date> T12:55: :00</Date> <UserName>VIVIANA</UserName> <SystemDate> T12:00: :00</SystemDate> <Office>ANT</Office> <OfficeName>ANTIOQUIA</OfficeName> <Sender>1</Sender> <SenderName>UNIVERSIDAD DEL ATLANTICO</SenderName> <Matter>Respuesta PQRS - Ref.Exp.: EXP2014/000034</Matter> <Persns/> <Dcuments> <WSDcument Id="0"> <Name>Dcument</Name> <Pages> <WSPage Id="1"> <Name>1577.dc</Name> <Lcatr/> </WSPage> </Pages> </WSDcument> </Dcuments> <AddFields> <WSAddField> <FieldId>14</FieldId> </WSAddField> <WSAddField> <FieldId>500</FieldId> </WSAddField> <WSAddField> <FieldId>1000</FieldId> </WSAddField> <WSAddField> <FieldId>15</FieldId> </WSAddField> <WSAddField> <FieldId>1001</FieldId> </WSAddField> </AddFields> </WSOutputRegister> </List> </WSLadOutputRegistersResult> </WSLadOutputRegistersRespnse> </sap:bdy> </sap:envelpe> [Pág. 17 de 31]

14 Nta 1: Camp Cnditin: Clumnas Dispnibles: Fld1: Numer de Registr Fld2: Fecha de Registr Ejempl: Fld1 = '2014WEB ' Fld2 >= '01/03/2014 Fld2 >= '01/03/2014' AND Fld2 <= '08/04/2014' Nta 2: Camp FieldId 14: Cmentaris 1001: Distribuid Obtener dcuments de un registr de crrespndencia A cntinuación se explica cóm acceder a ls dcuments que están asciads a un registr de crrespndencia. Servici WSGetPage Parámetrs de cnsulta Nmbre Descripción Tip Observacines Security Tken de Seguridad Cmpue st BkIdentificatin Id del Libr Numéric Valr: 1 (Entrada), 2 (Salida) RegisterIdentificatin Id del Registr (FlderId) Numéric DcumentIndex Cnsecutiv del dcument dentr del registr Numéric PageIndex Cnsecutiv de la pagina Numéric dentr del registr Resultad de la cnsulta Nmbre Descripción Tip Observacines WSGetPageResult Cntenid del archiv (bytes en base 64) BYTES Ejempl Petición <sapenv:envelpe xmlns:sapenv=" xmlns:sec=" xmlns:inv=" <sapenv:header> <sec:security> <sec:usernametken> <sec:username>pqr@cpnia.gv.c</sec:username> <sec:passwrd>12345</sec:passwrd> <sec:officecde>nal</sec:officecde> <sec:checkpermissins>1</sec:checkpermissins> </sec:usernametken> </sec:security> </sapenv:header> <sapenv:bdy> <inv:wsgetpage> [Pág. 18 de 31]

15 Resultad <inv:bkidentificatin>1</inv:bkidentificatin> <inv:registeridentificatin>681</inv:registeridentificatin> <inv:dcumentindex>1</inv:dcumentindex> <inv:pageindex>1</inv:pageindex> </inv:wsgetpage> </sapenv:bdy> </sapenv:envelpe> <sap:envelpe xmlns:sap=" <sap:bdy> <WSGetPageRespnse xmlns:ns2=" xmlns=" <WSGetPageResult> BYTES DEL ARCHIVO BASE64 </WSGetPageResult> </WSGetPageRespnse> </sap:bdy> </sap:envelpe> [Pág. 19 de 31]

16 3.4 Servicis Dcumentales Ls servicis dcumentales frecids pr la platafrma invesdc se basan en la especificación CMIS Acces La URL para acceder a ls servicis web es: Cliente CMIS Para pder acceder a ls servicis dcumentales se deben usar Apis aplicacines que sprten realizar cnsultas usand la especificación CMIS, en el siguiente capítul se da explicación del us de CMIS. [Pág. 20 de 31]

17 4. SERVICIOS CMIS 4.1 INTRODUCCIÓN En esta página explicarems cm hacer us de ls servicis CMIS implementads y que se cnectan cn Invesdc. La aplicación se encuentra instalada en el entrn de prducción, la url es Una vez entrams ahí vems la siguiente pantalla: Apache Chemistry ns prprcina las siguientes interfaces: Atm: SOAP Web Service: Acces pr navegadr: [Pág. 21 de 31]

18 Intefaz Web: N implementad. 4.2 APACHE CHEMISTRY OPENCMIS WORKBENCH El Apache Chemitry OpenCMIS Wrkbench, es una utilidad prprcinada pr el pryect para pder realizar pruebas de nuestrs servicis. La pdems descargar de Una vez descargada y descmprimida la abrims y vems: [Pág. 22 de 31]

19 Cn el wrkbench pdems prbar tds ls servicis que hems implementad CONEXIÓN Para realizar la cnexión debems intrducir en el camp URL la dirección del tip de binding seleccinad, así cm un usuari y cntraseña. Una vez intrducids ls dats: 1. Pulsams en "Lad Repsitries". 2. Escgems el repsitri (Archivadr sbre el que querems trabajar) 3. Y pulsams lgin DATOS DEL REPOSITORIO Llegads a este punt pdems ver cierts dats del repsitri, mviendns entre las distintas pestañas, ejempl. [Pág. 23 de 31]

20 Aunque la infrmación cmpleta la tenems en la pcin "Repsitry Inf" y "Types" de la barra de herramientas. En Repsitry Inf pdems la infrmación básica del repsitri: Mientras que en Types pdems ver mucha más infrmación y más detallada... de la que destacarems la infrmación marcada en las imágenes [Pág. 24 de 31]

21 [Pág. 25 de 31]

22 1. Id: es el identificadr del tip (repsitri/archivadr): Ns será útil para hacer cnsultas persnalizadas 2. Query Name: Es la crrespndencia entre el id y cm se ha de nmbrar en las cnsultas persnalizadas 3. Name: Nmbre del camp 4. Id: Identificadr del camp para CMIS. 5. Type: Tip del camp 6. Chices: Psibles valres que puede tmar el camp (en invesdc... psibles valres del camp según la tabla validada que tiene asciada). [Pág. 26 de 31]

23 DATOS DE UN DOCUMENTO (CARPETA) Para recuperar ls dats de una carpeta pdems hacerl a través de la "barra de direccines", intrduciend el identificadr de la carpeta que deseams btener y pulsand el btn "GO" En las distintas pestañas pdems ver la infrmación de dicha carpeta, las más relevantes sn las pestañas "Object", "Actins" y "Prperties": Pestaña Object: Pdems ver ls dats principales del dcument, cm sn el id, el tip y las accines permitidas [Pág. 27 de 31]

24 Pestaña Prperties: Pdems ver el valr que tienen sus camps. Pestaña Actins: Pdems ver las psibles pcines a realizar cn el dcument. [Pág. 28 de 31]

25 CONSULTA PERSONALIZADA / AVANZADA Si seleccinams la pción "Query" en la barra de herramientas, se ns abre una ventana dnde pdems realizar una cnsulta "SQL". Esta cnsulta "SQL" es un pc especial, y es una mezcla entre SQL y ls términs de CMIS. Pr ejempl en lugar de una tabla harems referencia al tip que querems cnsultar y en el "WHERE" en lugar de clumnas, cnsultarems en función de ls id de ls camps. [Pág. 29 de 31]

26 [Pág. 30 de 31]

27 ecllect Technical Guide February 2008 Versin 3.32 Cntents 1. Intrductin 3 Cnventins 3 2. Payment Prcess Steps 4 3. Hw t Begin a Transactin (Web Service)? 7 createtransactinpayment Request 7 createtransactinpayment Respnse Hw t Get Transactin Respnse (Web Service)? 11 gettransactininfrmatin Request 11 gettransactininfrmatin Respnse Transactin States

28 ecllect Technical Guide February 2008 Versin Intrductin Avisr Technlgies has develped an integrated payment platfrm which allws any ecmmerce t receive custmer n line payments frm credit card and bank payments system. This dcument is written fr business applicatin prgrammers familiar with web and applicatin server and web prgramming languages. Cnventins Over this entire dcument the term Financial Institutin means any bank r any credit card payment systems that is integrated with ecllect ecmmerce platfrm. MYSHOP means a sample name f a cmpany that already has a website where custmers are able t get prices f prducts r services. 3

29 ecllect Technical Guide February 2008 Versin Payment Prcess Steps Step Descriptin 1 Custmer ges t MYSHOP s website t chse prducts r services he wants t pay fr. Here MYSHOP s website must tell him the amunt t pay fr prducts r services selected. When custmer click pay, yu create a transactin n ecllect platfrm and sent him t ecllect webpage. 4

30 ecllect Technical Guide February 2008 Versin Custmer chses the payment system he wants t pay with. The available payment systems list depends n yur cmpany cnfiguratin, it means, n ecllect are cnfigured the payment systems MYSHOP authrized t shw t its custmers. 3 a. Pay with a bank: ecllect sends custmer t his bank s website. Bank is up t authenticate him and must authrize r deny a debit frm any accunt he has with it. b. Pay with a credit card: Custmer fills an https-frm with credit card infrmatin needed fr payment. ecllect prcess this with the credit card gateway t get an authrizatin r deny respnse. ecllect creates transactins n Financial Institutins platfrms sending secure 5

31 ecllect Technical Guide February 2008 Versin 3.32 messages digital signed with a SSL certificate and ver server t server VPN (Virtual Private Netwrk). 4 ecllect shws the final transactin state accrding t Financial Institutins respnse. Custmer is returned t MYSHOP s website and gets a receipt. At this pint ecllect has already sent the transactin state and ther imprtant data t MYSHOP s web applicatin. MYSHOP must develp business rules depending n the respnse received frm financial institutin (deny r authrized payment). 6

32 ecllect Technical Guide February 2008 Versin Hw t Begin a Transactin (Web Service)? This happened in step 1 when custmer clicks t Pay buttn. Frm MYSHOP s web applicatin shuld be sent all infrmatin needed t identify and prcess payment request in the Financial Institutin. createtransactinpayment Request Name Type Descriptin Required EntityCde String Internal entity cde given by Avisr Technlgies. Yes SrvCde Integer1t10 Service cde identifies the kind cncept custmer is ging t pay. This is useful when MYSHOP has different services can be bught, fr instance, seminars, inscriptins, cnsulting, reservatins, etc. But when is a shpping cart it desn t mean t send prducts cde, in this case, send nly a service cde indicating it is a buying frm the shpping. TransValue Decimal Value t pay withut Taxes. Yes N Frmat: Max decimals: 2 Decimal separatr:. (pint) If n sent, the value can be defined in ecllect. TransVatValue Decimal Ttal Taxes. N Frmat: Max decimals: 2 Decimal separatr:. (pint) If n sent, the value can be defined in ecllect. SrvCurrency String1t3 Crrespnding cuntry currency cde as TransValue and TransVatValue are represented in. ISO 4217 N URLRespnse String1t500 Sent in blank N URLRedirect String1t500 Specifies the URL where custmers must be sent when authrizatin prcess has finished. Is recmmended t include yur internal transactin id as a GET parameter at the end f the URL s yu can N 7

33 ecllect Technical Guide February 2008 Versin 3.32 identify what transactin is it abut. When yur applicatin receive this URL yu are able t knw all the infrmatin frm the financial institutin using Web Service: gettransactininfrmatin Transactinid=AS6DG89239GG In this sample the TransactinId is encrypted using yur wn algrithm. Sign String1t500 It s a stream data signed with a MD5 algrithm. It s useful t identify the surce f this request. N SignFields String1t500 It s a stream f a list f field s names including in the N sing. Payment References (Array) Reference1 String1t20 Identify the buyer. Yes Reference2 String1t20 Additinal payment infrmatin. N Reference3 String1t20 Additinal payment infrmatin. N Reference4 String1t80 Additinal payment infrmatin. N Reference5 String1t80 Additinal payment infrmatin. N Reference6 String1t80 Additinal payment infrmatin. N Reference-n String1t80 Additinal payment infrmatin. N Imprtant Ntes: References 2 t n, are used t identify the payment cmpletely and allws custmers t verify that infrmatin befre paying. It s highly recmmended t send mre than ne references, this is a valued added fr yur custmers. Yu can send any number f references as needed t describe the buying. Reference2 it s recmmended t use t identify what is he paying fr. Send an rder number, reservatin number, invice number, etc, smething that identify uniquely this buying frm thers. It s highly recmmended include buyer s name and , they can be placed in Reference3 and Reference4 fields. The is very useful t ntify yur custmers the transactin state even if they are nt n Internet. The ther references can be used t describe payment, fr instance, phne number, reservatin data, ther detailed taxes (nly infrmatin, included in TransVatValue), etc. 8

34 ecllect Technical Guide February 2008 Versin 3.32 createtransactintype <createtransactinpayment> <request> <EntityCde>string</EntityCde> <SrvCde>string</SrvCde> <TransValue>decimal</TransValue> <TransVatValue>decimal</TransVatValue> <SrvCurrency>string</SrvCurrency> <URLRespnse>string</URLRespnse> <URLRedirect>string</URLRedirect> <Sign>string</Sign> <SignFields>string</SignFields> <ReferenceArray>string</ReferenceArray> <ReferenceArray>string</ReferenceArray> </request> </createtransactinpayment> 9

35 ecllect Technical Guide February 2008 Versin 3.32 createtransactinpayment Respnse createtransactinrespnsetype Name Type Descriptin Required ReturnCde String Indicates if the web service requests was successful r nt, see pssible Return Cdes belw. Yes TicketId Integer1t10 Identifies the transactin number that was created n ecllect fr this request. Yu must use this number t ask fr this transactin later. ecllecturl String ecllect return the URL where yu must redirect the Custmer, nly when the ReturnCde respnse was SUCCCESS. Yes Yes <createtransactinpaymentrespnse xmlns=" Webservices"> <createtransactinpaymentresult> <ReturnCde>string</ReturnCde> <TicketId>string</TicketId> <ecllecturl>string</ecllecturl> </createtransactinpaymentresult> </createtransactinpaymentrespnse> ReturnCde State SUCCESS FAIL_INVALIDENTITYCODE FAIL_INVALIDSERVICECODE FAIL_INVALIDREFERENCE1 FAIL_INVALIDTRANSVALUE FAIL_INVALIDVATVALUE FAIL_INVALIDCURRENCY FAIL_SYSTEM Descriptin The request was prcess successfully. Custmer must be sent t the address given in ecllecturl. This redirect shuld be in the same windw, is nt recmmended t pen a ppup windws t avid duble payments. The EntityCde field des nt exist, is null r blank. The SrvCde field is null r blank. The ReferenceArray must cntain alt least ne reference and it shuldn t be null r blank. The TransValue Field failed t be cnverted t a Currency value. It can nt be negative number. Frmats allwed are ##### r ####.## withut thusand character. The TransVatValue Field failed t be cnverted t a Currency value. It can nt be negative number. Frmats allwed are ##### r ####.## withut thusand character. SrvCurrency must be ne f COP r USD currency cdes The Web Service failed 10

36 ecllect Technical Guide February 2008 Versin Hw t Get Transactin Respnse (Web Service)? This happens when authrizatin prcess has finished in the financial institutin and the custmer has been redirected t the address specified in URLRedirect parameter. At this time yu must cnsume this web service t knw the final transactin status and all infrmatin related. gettransactininfrmatin Request gettransactininfrmatintype EntityCde String Internal entity cde given by Avisr Technlgies. TicketId Integer1t10 Identifies the transactin number that was given by ecllect when web service createtransactin was cnsumed. Yes Yes <gettransactininfrmatin xmlns=" Webservices"> <request> <EntityCde>string</EntityCde> <TicketId>string</TicketId> </request> </gettransactininfrmatin> gettransactininfrmatin Respnse gettransactininfrmatinrespnsetype Name Type Descriptin Required Transactin Infrmatin (Original Fields) EntityCde String Internal entity cde given by Avisr Technlgies. Yes TransValue Decimal Value t pay withut Taxes. Value prcessed by Financial Institutin in the currency described in PayCurrency. Yes Frmat: Max decimals: 2 Decimal separatr:. (pint) 11