anexo web service
Transcripción
anexo web service
ANEXO TECNICO WEB DE SERVICE FUNCIONALES INVESDOC GALLERY SUITE ‐ ECOLLECT Web Services INVESDOC 3. SERVICIOS WEB 3.1 Servicio Ofrecidos en el modulo de Invesdoc 3.1.1 Acceso La URL para acceder a los servicios web es: http://xxxxxxxxxx:8080/invesdoc-ws/ServicioCopnia WSDL: http://186.28.253.221:8080/invesdoc-ws/ServicioCopnia?wsdl 3.1.2 Obtener Seccionales Permite la consulta de las seccionales que están registradas en la base de datos Servicio getSeccionales Parámetros de consulta Nombre Descripción codigo Codigo de la Seccional Tipo Numeric o Resultado de la consulta Nombre Descripción codigo Codigo de la seccional nombre idDepartament o Tipo Numeric o Nombre de la seccional Alfanum erico Identificador del departamento de la Numeric estructura de usuarios al que o pertenece la seccional Observaciones Opcional Observaciones Se repite por cada seccional que se retorna en la consulta 3.1.3 Obtener Instituciones Permite la consulta de las instituciones educativas que están registradas en la base de datos Servicio getInstituciones Parámetros de consulta Nombre Descripción Resultado de la consulta Nombre Descripción codigo Codigo de la universidad nombre 09/04/2014. versión 1.0 Nombre de la universidad Tipo Observaciones Tipo Numeric o Alfanum Observaciones Se repite por cada universidad que se retorna en la consulta [Pág. 6 de 31] Web Services INVESDOC erico 3.1.4 Obtener Profesiones Permite la consulta de las instituciones educativas que están registradas en la base de datos Servicio getProfesiones Parámetros de consulta Nombre Descripción Tipo institucion Código de la institución de la que se Numeric desean las profesiones o Resultado de la consulta Nombre Descripción Tipo codigo Codigo de la profesión Numeric o nombre Nombre de la profesión Alfanum erico Observaciones Opcional Observaciones Se repite por cada profesion que se retorna en la consulta 3.1.5 Obtener Egresado Permite la consulta de la información de un Egresado Servicio getEgresado Parámetros de consulta Nombre Descripción tipoIdentificacio Tipo de identificación n identificacion Número de identificación Tipo Alfanum érico Numéric o Observaciones CC, CE Tipo Alfanum erico Alfanum erico Nombre del Egresado Alfanum erico Apellidos del Egresado Alfanum erico Fecha de Grado Fecha Datos de la institución Compue sto Información del listado donde Compue aparece el Egresado sto Número de acta Alfanum erico Número de Libro/Folio donde está Alfanum registrado el titulo erico Observaciones Resultado de la consulta Nombre Descripción tipoIdentificacio Tipo de identificación del Egresado n identificacion Identificación del Egresado nombre apellidos fechaGrado institucion listadoEgresad o numActaGrado numLibroFolio RegTitulo 09/04/2014. versión 1.0 Opcional [Pág. 7 de 31] Web Services INVESDOC numUDP Número de Unidad Documental profesion Datos de la profesion seccionalUDP Datos de la seccional de la Unidad Documental Datos de la institución codigo Codigo de la institución nombre Nombre de la institución Datos del listado del Egresado Fecha Folio Identificador seccional Datos de la seccional Ubicación unidadDocume ntal Universidad Datos de la Universidad Datos de la seccional codigo Codigo de la seccional nombre Nombre de la seccional idDepartament Identificador del departamento en o Invesdoc Datos de la Universidad codigo Codigo de la universidad nombre Nombre de la universidad Datos de la Profesion codigo Codigo de la profesión nombre 3.2 Nombre de la profesión Alfanum erico Compue sto Compue sto Datos de Seccional Numéric o Alfanum érico Fecha Alfanum érico Alfanum érico Compue sto Alfanum érico Alfanum érico Compue sto Numeric o Alfanum erico Numeric o Numeric o Alfanum erico Numeric o Alfanum erico Servicio Ofrecidos en el modulo de Invesflow 3.2.1 Acceso La URL para acceder a los servicios web es: http://xxxxxxxx:8080/ispacservicesws/services/TramitacionWebService 09/04/2014. versión 1.0 [Pág. 8 de 31] Web Services INVESDOC WSDL: http://23.21.172.89:8080/ispacservicesws/services/TramitacionWebService?wsdl 3.2.2 Obtener información de Entidades A continuación se explica cómo acceder a la información de los datos de determinadas entidades que se encuentran cargadas en la base de datos de invesflow. Para poder acceder a los datos de una entidad se requiere conocer el expediente desde el cual se cargaron dichos datos. 3.2.2.1 Obtener Pagos Permite la consulta de los datos de pagos cargados a través del procedimiento de Acreedores Servicio obtenerRegistrosEntidad Parámetros de consulta Nombre Descripción Tipo Observaciones nombreEntidad Nombre de la entidad que contiene Alfanum Valor: IVF_PAGOS los datos érico numExp Número de expediente Alfanum érico Resultado de la consulta Nombre Descripción Tipo Observaciones errorCode Código de error Numeric o returnCode Código de resultado Alfanum erico valor Resultado de la consulta, en XML Alfanum erico Ejemplo <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" Petición Resultado 09/04/2014. versión 1.0 xmlns:ser="http://server.ws.services.ispac.tdw.ieci"> <soapenv:Header/> <soapenv:Body> <ser:obtenerRegistrosEntidad> <ser:nombreEntidad>IVF_PAGOS</ser:nombreEntidad> <ser:numExp>EXP2013/000539</ser:numExp> </ser:obtenerRegistrosEntidad> </soapenv:Body> </soapenv:Envelope> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> <obtenerRegistrosEntidadResponse xmlns="http://server.ws.services.ispac.tdw.ieci"> <obtenerRegistrosEntidad> <errorCode xsi:nil="true"/> <returnCode>OK</returnCode> <valor><![CDATA[<?xml version='1.0' encoding='ISO-8859-1'?><results> <item><value name='ID'><![CDATA[425]]]]>><![CDATA[</value><value [Pág. 9 de 31] Web Services INVESDOC name='NUMEXP'><![CDATA[EXP2013/000539]]]]>><![CDATA[</value><value name='FECHA_REGISTRO'><![CDATA[04/12/2013]]]]>><![CDATA[</value><value name='ID_PAGO'><![CDATA[17905330]]]]>><![CDATA[</value><value name='VALOR_RECAUDADO'><![CDATA[23600000]]]]>><![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[17917816]]]]>><![CDATA[</value><value name='VALOR_RECAUDADO'><![CDATA[13700000]]]]>><![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[17911016]]]]>><![CDATA[</value><value name='VALOR_RECAUDADO'><![CDATA[23600000]]]]>><![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>]]></valor> </obtenerRegistrosEntidad> </obtenerRegistrosEntidadResponse> </soapenv:Body> </soapenv:Envelope> 3.3 Servicio Ofrecidos en el modulo de ISicres (Correspondencia) 3.3.1 Acceso La URL para acceder a los servicios web es: http://XXXXXXXX:8080/ISicresWS/ISWebServiceRegisters WSDL: http://23.21.172.89:8080/ISicresWS/ISWebServiceRegisters?wsdl Para poder acceder a los servicios de ISicres se maneja dentro de la petición del servicio web los datos de autorización para el usuario con Token de Seguridad, como se indica a continuación: 09/04/2014. versión 1.0 [Pág. 10 de 31] Web Services INVESDOC Nombre Security UsernameToken Username Password OfficeCode CheckPermissions Descripción Contiene la información de seguridad para el acceso Contiene datos de seguridad Nombre de Usuario Password Codigo de oficina Validar permisos Tipo Compuesto Observaciones Compuesto Alfanumerico Alfanumerico Alfanumerico Numerico Valor: web Valor: 12345 Valor: 01 Valor: 1 3.3.2 Obtener información de registros de correspondencia de Entrada A continuación se explica cómo acceder a la información de los datos de l os registros de correspondencia de Entrada. Servicio WSLoadInputRegisters Parámetros de consulta Nombre Descripción Security Token de Seguridad Tipo Compue sto BookIdentification Id del libro de correspondencia Alfanum érico Condition Número de expediente Alfanum érico InitValue Rango inicial Numéric o Size Cantidad de registros a Numéric consultar o Resultado de la consulta Nombre Descripción Tipo WSInputRegister Compue sto State Estado FolderId Id del Registro BookId Id del Libro Number Numero del registro Date UserName Fecha del registro Usuario SystemDate Office Fecha de trabajo Código de oficina OfficeName Nombre de oficina 09/04/2014. versión 1.0 Observaciones Valor: 1 Sentencias SQL para traer datos, Ver Nota 1 Valor: 1 Observaciones Este dato se repite de acuerdo a la cantidad de resultados de la búsqueda. Numéric o Numéric o Numéric o Alfanum érico Fecha Alfanum érico Fecha Alfanum érico Alfanum érico [Pág. 11 de 31] Web Services INVESDOC Destination Código del destino DestinationName Nombre del destino MatterType Código del Tipo de Asunto Nombre del Tipo de Asunto Resumen MatterTypeName Matter Persons Id Información del remitente Identificador remitente Name Nombre del remitente Documents Documentos WSDocument Documento Id Name Identificador del documento Nombre del documento Pages Paginas / Archivos WSPage Pagina / Archivo Id Identificador Name Nombre del Archivo Locator AddFields WSAddField Campo adicional FieldId Id del campo Value Valor del campo Ejemplo Petición 09/04/2014. versión 1.0 Campos adicionales Alfanum érico Alfanum érico Alfanum érico Alfanum érico Alfanum érico Compue sto Alfanum érico Alfanum érico Compue sto Compue sto Alfanum érico Alfanum érico Compue sto Compue sto Numeric o Alfanum érico Alfanum érico Compue sto Compue sto Numéric o Alfanum érico Ver Nota 2 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sec="http://schemas.xmlsoap.org/ws/2002/04/secext" xmlns:inv="http://www.invesicres.org"> <soapenv:Header> <sec:Security> <sec:UsernameToken> <sec:Username>[email protected]</sec:Username> <sec:Password>12345</sec:Password> <sec:OfficeCode>NAL</sec:OfficeCode> <sec:CheckPermissions>1</sec:CheckPermissions> [Pág. 12 de 31] Web Services INVESDOC Resultado 09/04/2014. versión 1.0 </sec:UsernameToken> </sec:Security> </soapenv:Header> <soapenv:Body> <inv:WSLoadInputRegisters> <inv:BookIdentification>1</inv:BookIdentification> <inv:Condition>Fld1 = '2014WEB00000057'</inv:Condition> <inv:InitValue>1</inv:InitValue> <inv:Size>100</inv:Size> </inv:WSLoadInputRegisters> </soapenv:Body> </soapenv:Envelope> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <WSLoadInputRegistersResponse xmlns:ns2="http://schemas.xmlsoap.org/ws/2002/04/secext" xmlns="http://www.invesicres.org"> <WSLoadInputRegistersResult Total="1"> <List> <WSInputRegister State="0" FolderId="699" BookId="1"> <Number>2014WEB00000057</Number> <Date>2014-04-08T02:14:43.293-05:00</Date> <UserName>web</UserName> <SystemDate>2014-04-08T02:14:43.290-05:00</SystemDate> <Office>WEB</Office> <OfficeName>OFICINA DE REGISTRO TELEMÁTICO</OfficeName> <Destination>001</Destination> <DestinationName>COPNIA</DestinationName> <MatterType>PET-CONSVER</MatterType> <MatterTypeName>Peticiones - Consulta Verificación de Registro</MatterTypeName> <Matter>Petición, Queja, Reclamo o Sugerencia</Matter> <Persons> <WSPerson Id="1804"> <Name>Alfonso Suarez Alicia Maria</Name> </WSPerson> </Persons> <Documents> <WSDocument Id="992"> <Name>Justificante de Registro</Name> <Pages> <WSPage Id="1"> <Name>Justificante de Registro.pdf</Name> <Locator>4501</Locator> </WSPage> </Pages> </WSDocument> <WSDocument Id="993"> <Name>Solicitud de Registro</Name> <Pages> <WSPage Id="2"> <Name>Solicitud de Registro.xml</Name> <Locator>4502</Locator> </WSPage> [Pág. 13 de 31] Web Services INVESDOC </Pages> </WSDocument> </Documents> <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> </WSLoadInputRegistersResult> </WSLoadInputRegistersResponse> </soap:Body> </soap:Envelope> Nota 1: Campo Condition: Columnas Disponibles: Fld1: Numero de Registro Fld2: Fecha de Registro Ejemplo: Fld1 = '2014WEB00000057' Fld2 >= '01/03/2014’ Fld2 >= '01/03/2014' AND Fld2 <= '08/04/2014' Nota 2: Campo FieldId 18: Comentarios 500: LimiteInferiorReserva 1000: LimiteSuperiorReserva 1001: Distribuido 1002: ID_EMAIL 09/04/2014. versión 1.0 [Pág. 14 de 31] Web Services INVESDOC 3.3.3 Obtener información de registros de correspondencia de Salida A continuación se explica cómo acceder a la información de los datos de los registros de correspondencia de Salida Servicio WSLoadOutputRegisters Parámetros de consulta Nombre Descripción Security Token de Seguridad Tipo Compue sto BookIdentification Id del libro de correspondencia Alfanum érico Condition Número de expediente Alfanum érico InitValue Rango inicial Numéric o Size Cantidad de registros a Numéric consultar o Resultado de la consulta Nombre Descripción Tipo WSOutputRegister Compue sto State Estado FolderId Id del Registro BookId Id del Libro Number Numero del registro Date UserName Fecha del registro Usuario SystemDate Office Fecha de trabajo Código de oficina OfficeName Nombre de oficina Sender Código del destino SenderName Nombre del destino MatterType Matter Código del Tipo de Asunto Nombre del Tipo de Asunto Resumen Persons Información del MatterTypeName 09/04/2014. versión 1.0 Observaciones Valor: 2 Sentencias SQL para traer datos, Ver Nota 1 Valor: 1 Observaciones Este dato se repite de acuerdo a la cantidad de resultados de la búsqueda. Numéric o Numéric o Numéric o Alfanum érico Fecha Alfanum érico Fecha Alfanum érico Alfanum érico Alfanum érico Alfanum érico Alfanum érico Alfanum érico Alfanum érico Compue [Pág. 15 de 31] Web Services INVESDOC Id remitente Identificador remitente Name Nombre del remitente Documents Documentos WSDocument Documento Id Name Identificador del documento Nombre del documento Pages Paginas / Archivos WSPage Pagina / Archivo Id Identificador Name Nombre del Archivo Locator AddFields WSAddField Campo adicional FieldId Id del campo Value Valor del campo Ejemplo Petición 09/04/2014. versión 1.0 Campos adicionales sto Alfanum érico Alfanum érico Compue sto Compue sto Alfanum érico Alfanum érico Compue sto Compue sto Numeric o Alfanum érico Alfanum érico Compue sto Compue sto Numéric o Alfanum érico Ver Nota 2 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sec="http://schemas.xmlsoap.org/ws/2002/04/secext" xmlns:inv="http://www.invesicres.org"> <soapenv:Header> <sec:Security> <sec:UsernameToken> <sec:Username>[email protected]</sec:Username> <sec:Password>12345</sec:Password> <sec:OfficeCode>NAL</sec:OfficeCode> <sec:CheckPermissions>1</sec:CheckPermissions> </sec:UsernameToken> </sec:Security> </soapenv:Header> <soapenv:Body> <inv:WSLoadOutputRegisters> <inv:BookIdentification>2</inv:BookIdentification> <inv:Condition>Fld2 >= '01/01/2014' </inv:Condition> <inv:InitValue>1</inv:InitValue> <inv:Size>100</inv:Size> </inv:WSLoadOutputRegisters> </soapenv:Body> [Pág. 16 de 31] Web Services INVESDOC Resultado 09/04/2014. versión 1.0 </soapenv:Envelope> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <WSLoadOutputRegistersResponse xmlns:ns2="http://schemas.xmlsoap.org/ws/2002/04/secext" xmlns="http://www.invesicres.org"> <WSLoadOutputRegistersResult Total="1"> <List> <WSOutputRegister State="0" FolderId="183" BookId="2"> <Number>2014ANT00000002</Number> <Date>2014-01-09T12:55:22.767-05:00</Date> <UserName>VIVIANA</UserName> <SystemDate>2014-01-09T12:00:00.000-05:00</SystemDate> <Office>ANT</Office> <OfficeName>ANTIOQUIA</OfficeName> <Sender>1</Sender> <SenderName>UNIVERSIDAD DEL ATLANTICO</SenderName> <Matter>Respuesta PQRS - Ref.Exp.: EXP2014/000034</Matter> <Persons/> <Documents> <WSDocument Id="0"> <Name>Documento</Name> <Pages> <WSPage Id="1"> <Name>1577.doc</Name> <Locator/> </WSPage> </Pages> </WSDocument> </Documents> <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> </WSLoadOutputRegistersResult> </WSLoadOutputRegistersResponse> </soap:Body> </soap:Envelope> [Pág. 17 de 31] Web Services INVESDOC Nota 1: Campo Condition: Columnas Disponibles: Fld1: Numero de Registro Fld2: Fecha de Registro Ejemplo: Fld1 = '2014WEB00000057' Fld2 >= '01/03/2014’ Fld2 >= '01/03/2014' AND Fld2 <= '08/04/2014' Nota 2: Campo FieldId 14: Comentarios 1001: Distribuido 3.3.4 Obtener documentos de un registro de correspondencia A continuación se explica cómo acceder a los documentos que están asociados a un registro de correspondencia. Servicio WSGetPage Parámetros de consulta Nombre Descripción Security Token de Seguridad Tipo Observaciones Compue sto BookIdentification Id del Libro Numéric Valor: 1 (Entrada), 2 o (Salida) RegisterIdentification Id del Registro (FolderId) Numéric o DocumentIndex Consecutivo del documento Numéric dentro del registro o PageIndex Consecutivo de la pagina Numéric dentro del registro o Resultado de la consulta Nombre Descripción Tipo Observaciones WSGetPageResult Contenido del archivo BYTES (bytes en base 64) Ejemplo <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" Petición xmlns:sec="http://schemas.xmlsoap.org/ws/2002/04/secext" xmlns:inv="http://www.invesicres.org"> <soapenv:Header> <sec:Security> <sec:UsernameToken> <sec:Username>[email protected]</sec:Username> <sec:Password>12345</sec:Password> <sec:OfficeCode>NAL</sec:OfficeCode> <sec:CheckPermissions>1</sec:CheckPermissions> </sec:UsernameToken> </sec:Security> </soapenv:Header> <soapenv:Body> <inv:WSGetPage> 09/04/2014. versión 1.0 [Pág. 18 de 31] Web Services INVESDOC Resultado 09/04/2014. versión 1.0 <inv:BookIdentification>1</inv:BookIdentification> <inv:RegisterIdentification>681</inv:RegisterIdentification> <inv:DocumentIndex>1</inv:DocumentIndex> <inv:PageIndex>1</inv:PageIndex> </inv:WSGetPage> </soapenv:Body> </soapenv:Envelope> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <WSGetPageResponse xmlns:ns2="http://schemas.xmlsoap.org/ws/2002/04/secext" xmlns="http://www.invesicres.org"> <WSGetPageResult> BYTES DEL ARCHIVO BASE64 </WSGetPageResult> </WSGetPageResponse> </soap:Body> </soap:Envelope> [Pág. 19 de 31] Web Services INVESDOC 3.4 Servicios Documentales Los servicios documentales ofrecidos por la plataforma invesdoc se basan en la especificación CMIS 3.4.1 Acceso La URL para acceder a los servicios web es: http://xxxxxxxxxx:8080/invesdoc-cmis/ 3.4.2 Cliente CMIS Para poder acceder a los servicios documentales se deben usar Apis o aplicaciones que soporten realizar consultas usando la especificación CMIS, en el siguiente capítulo se da explicación del uso de CMIS. 09/04/2014. versión 1.0 [Pág. 20 de 31] Web Services INVESDOC 4. SERVICIOS CMIS 4.1 INTRODUCCIÓN En esta página explicaremos como hacer uso de los servicios CMIS implementados y que se conectan con Invesdoc. La aplicación se encuentra instalada en el entorno de producción, la url es http://xxxxxxx:8080/invesdoc-cmis/ Una vez entramos ahí vemos la siguiente pantalla: Apache Chemistry nos proporciona las siguientes interfaces: 09/04/2014. versión 1.0 Atom: http://XXXXXXX:8080/invesdoc-cmis/atom SOAP Web Service: http://XXXXXX:8080/invesdoc-cmis/services/cmis?wsdl Acceso por navegador: http://XXXXXXX:8080/invesdoc-cmis/browser [Pág. 21 de 31] Web Services INVESDOC 4.2 Intefaz Web: No implementado. APACHE CHEMISTRY OPENCMIS WORKBENCH El Apache Chemitry OpenCMIS Workbench, es una utilidad proporcionada por el proyecto para poder realizar pruebas de nuestros servicios. La podemos descargar de http://chemistry.apache.org/java/download.html Una vez descargada y descomprimida la abrimos y vemos: 09/04/2014. versión 1.0 [Pág. 22 de 31] Web Services INVESDOC Con el workbench podemos probar todos los servicios que hemos implementado. 4.2.1.1 CONEXIÓN Para realizar la conexión debemos introducir en el campo URL la dirección del tipo de binding seleccionado, así como un usuario y contraseña. Una vez introducidos los datos: 1. Pulsamos en "Load Repositories". 2. Escogemos el repositorio (Archivador sobre el que queremos trabajar) 3. Y pulsamos login 4.2.1.2 DATOS DEL REPOSITORIO Llegados a este punto podemos ver ciertos datos del repositorio, moviendonos entre las distintas pestañas, ejemplo. 09/04/2014. versión 1.0 [Pág. 23 de 31] Web Services INVESDOC Aunque la información completa la tenemos en la opcion "Repository Info" y "Types" de la barra de herramientas. En Repository Info podemos la información básica del repositorio: Mientras que en Types podemos ver mucha más información y más detallada... de la que destacaremos la información marcada en las imágenes 09/04/2014. versión 1.0 [Pág. 24 de 31] Web Services INVESDOC 09/04/2014. versión 1.0 [Pág. 25 de 31] Web Services INVESDOC 1. Id: es el identificador del tipo (repositorio/archivador): Nos será útil para hacer consultas personalizadas 2. Query Name: Es la correspondencia entre el id y como se ha de nombrar en las consultas personalizadas 3. Name: Nombre del campo 4. Id: Identificador del campo para CMIS. 5. Type: Tipo del campo 6. Choices: Posibles valores que puede tomar el campo (en invesdoc... posibles valores del campo según la tabla validada que tiene asociada). 09/04/2014. versión 1.0 [Pág. 26 de 31] Web Services INVESDOC 4.2.1.3 DATOS DE UN DOCUMENTO (CARPETA) Para recuperar los datos de una carpeta podemos hacerlo a través de la "barra de direcciones", introduciendo el identificador de la carpeta que deseamos obtener y pulsando el boton "GO" En las distintas pestañas podemos ver la información de dicha carpeta, las más relevantes son las pestañas "Object", "Actions" y "Properties": 09/04/2014. versión 1.0 Pestaña Object: Podemos ver los datos principales del documento, como son el id, el tipo y las acciones permitidas [Pág. 27 de 31] Web Services INVESDOC 09/04/2014. versión 1.0 Pestaña Properties: Podemos ver el valor que tienen sus campos. Pestaña Actions: Podemos ver las posibles opciones a realizar con el documento. [Pág. 28 de 31] Web Services INVESDOC 4.2.1.4 CONSULTA PERSONALIZADA / AVANZADA Si seleccionamos la opción "Query" en la barra de herramientas, se nos abre una ventana donde podemos realizar una consulta "SQL". Esta consulta "SQL" es un poco especial, y es una mezcla entre SQL y los términos de CMIS. Por ejemplo en lugar de una tabla haremos referencia al tipo que queremos consultar y en el "WHERE" en lugar de columnas, consultaremos en función de los id de los campos. 09/04/2014. versión 1.0 [Pág. 29 de 31] Web Services INVESDOC 09/04/2014. versión 1.0 [Pág. 30 de 31] eCollect® Technical Guide February 2008 Version 3.32 Contents 1. Introduction ________________________________________________________________ 3 Conventions __________________________________________________________________________ 3 2. Payment Process Steps _____________________________________________________ 4 3. How to Begin a Transaction (Web Service)? __________________________________ 7 createTransactionPayment Request ____________________________________________________ 7 createTransactionPayment Response _________________________________________________ 10 4. How to Get Transaction Response (Web Service)? ___________________________ 11 getTransactionInformation Request ___________________________________________________ 11 getTransactionInformation Response__________________________________________________ 11 5. Transaction States _________________________________________________________ 15 www.e-collect.com 2 eCollect® Technical Guide February 2008 Version 3.32 1. Introduction Avisor Technologies has developed an integrated payment platform which allows any eCommerce to receive customer on line payments from credit card and bank payments system. This document is written for business application programmers familiar with web and application server and web programming languages. Conventions Over this entire document the term “Financial Institution” means any bank or any credit card payment systems that is integrated with eCollect® ecommerce platform. “MYSHOP” means a sample name of a company that already has a website where customers are able to get prices of products or services. www.e-collect.com 3 eCollect® Technical Guide February 2008 Version 3.32 2. Payment Process Steps Step 1 Description Customer goes to MYSHOP’s website to choose products or services he wants to pay for. Here MYSHOP’s website must tell him the amount to pay for products or services selected. When customer click “pay”, you create a transaction on eCollect® platform and sent him to eCollect® webpage. www.e-collect.com 4 eCollect® Technical Guide February 2008 Version 3.32 2 Customer chooses the payment system he wants to pay with. The available payment systems list depends on your company configuration, it means, on eCollect® are configured the payment systems MYSHOP authorized to show to its customers. 3 a. Pay with a bank: eCollect® sends customer to his bank’s website. Bank is up to authenticate him and must authorize or deny a debit from any account he has with it. b. Pay with a credit card: Customer fills an https-form with credit card information needed for payment. eCollect® process this with the credit card gateway to get an authorization or deny response. eCollect® creates transactions on Financial Institutions platforms sending secure www.e-collect.com 5 eCollect® Technical Guide February 2008 Version 3.32 messages digital signed with a SSL certificate and over server to server VPN (Virtual Private Network). 4 eCollect® shows the final transaction state according to Financial Institutions response. Customer is returned to MYSHOP’s website and gets a receipt. At this point eCollect® has already sent the transaction state and other important data to MYSHOP’s web application. MYSHOP’ must develop business rules depending on the response received from financial institution (deny or authorized payment). www.e-collect.com 6 eCollect® Technical Guide February 2008 Version 3.32 3. How to Begin a Transaction (Web Service)? This happened in step 1 when customer clicks to “Pay” button. From MYSHOP’s web application should be sent all information needed to identify and process payment request in the Financial Institution. createTransactionPayment Request Name EntityCode Type String Description Internal entity code given by Avisor Technologies. Required Yes SrvCode Integer1to10 Service code identifies the kind concept customer is going to pay. This is useful when MYSHOP has different services can be bought, for instance, seminars, inscriptions, consulting, reservations, etc. But when is a shopping cart it doesn’t mean to send products code, in this case, send only a service code indicating it is a buying from the shopping. Yes TransValue Decimal Value to pay without Taxes. No Format: 99999.99 Max decimals: 2 Decimal separator: . (point) If no sent, the value can be defined in eCollect®. TransVatValue Decimal Total Taxes. No Format: 99999.99 Max decimals: 2 Decimal separator: . (point) If no sent, the value can be defined in eCollect®. SrvCurrency String1to3 Corresponding country currency code as TransValue and TransVatValue are represented in. ISO 4217 No URLResponse String1to500 Sent in blank No URLRedirect String1to500 Specifies the URL where customers must be sent when authorization process has finished. Is recommended to include your internal transaction id as a GET parameter at the end of the URL so you can No www.e-collect.com 7 eCollect® Technical Guide February 2008 Version 3.32 identify what transaction is it about. When your application receive this URL you are able to know all the information from the financial institution using Web Service: getTransactionInformation http://MyPulbicDomain/virtualDir/Confirmation.aspx? Transactionid=AS6DG89239GG In this sample the TransactionId is encrypted using your own algorithm. Sign String1to500 It’s a stream data signed with a MD5 algorithm. It’s useful to identify the source of this request. No SignFields String1to500 It’s a stream of a list of field’s names including in the sing. No Identify the buyer. Additional payment information. Additional payment information. Additional payment information. Additional payment information. Additional payment information. Additional payment information. Yes No No No No No No Payment References (Array) Reference1 String1to20 Reference2 String1to20 Reference3 String1to20 Reference4 String1to80 Reference5 String1to80 Reference6 String1to80 Reference-n String1to80 Important Notes: References 2 to n, are used to identify the payment completely and allows customers to verify that information before paying. It’s highly recommended to send more than one references, this is a valued added for your customers. You can send any number of references as needed to describe the buying. Reference2 it’s recommended to use to identify what is he paying for. Send an order number, reservation number, invoice number, etc, something that identify uniquely this buying from others. It’s highly recommended include buyer’s name and email, they can be placed in Reference3 and Reference4 fields. The email is very useful to notify your customers the transaction state even if they are not on Internet. The other references can be used to describe payment, for instance, phone number, reservation data, other detailed taxes (only information, included in TransVatValue), etc. www.e-collect.com 8 eCollect® Technical Guide February 2008 Version 3.32 createTransactionType <createTransactionPayment> <request> <EntityCode>string</EntityCode> <SrvCode>string</SrvCode> <TransValue>decimal</TransValue> <TransVatValue>decimal</TransVatValue> <SrvCurrency>string</SrvCurrency> <URLResponse>string</URLResponse> <URLRedirect>string</URLRedirect> <Sign>string</Sign> <SignFields>string</SignFields> <ReferenceArray>string</ReferenceArray> <ReferenceArray>string</ReferenceArray> </request> </createTransactionPayment> www.e-collect.com 9 eCollect® Technical Guide February 2008 Version 3.32 createTransactionPayment Response createTransactionResponseType Name ReturnCode Type String Description Indicates if the web service requests was successful or not, see possible Return Codes below. Required Yes TicketId Integer1to10 Identifies the transaction number that was created on eCollect® for this request. You must use this number to ask for this transaction later. Yes eCollectUrl String eCollect® return the URL where you must redirect the Customer, only when the ReturnCode response was SUCCCESS. Yes <createTransactionPaymentResponse xmlns="http://www.avisortech.com/eCollect®Webservices"> <createTransactionPaymentResult> <ReturnCode>string</ReturnCode> <TicketId>string</TicketId> <eCollectUrl>string</eCollectUrl> </createTransactionPaymentResult> </createTransactionPaymentResponse> ReturnCode State SUCCESS FAIL_INVALIDENTITYCODE FAIL_INVALIDSERVICECODE FAIL_INVALIDREFERENCE1 FAIL_INVALIDTRANSVALUE FAIL_INVALIDVATVALUE FAIL_INVALIDCURRENCY FAIL_SYSTEM Description The request was process successfully. Customer must be sent to the address given in eCollectUrl. This redirect should be in the same window, is not recommended to open a popup windows to avoid double payments. The EntityCode field does not exist, is null or blank. The SrvCode field is null or blank. The ReferenceArray must contain alt least one reference and it shouldn’t be null or blank. The TransValue Field failed to be converted to a Currency value. It can not be negative number. Formats allowed are ##### or ####.## without thousand character. The TransVatValue Field failed to be converted to a Currency value. It can not be negative number. Formats allowed are ##### or ####.## without thousand character. SrvCurrency must be one of COP or USD currency codes The Web Service failed www.e-collect.com 10 eCollect® Technical Guide February 2008 Version 3.32 4. How to Get Transaction Response (Web Service)? This happens when authorization process has finished in the financial institution and the customer has been redirected to the address specified in URLRedirect parameter. At this time you must consume this web service to know the final transaction status and all information related. getTransactionInformation Request getTransactionInformationType EntityCode String Internal entity code given by Avisor Technologies. Yes TicketId Integer1to10 Identifies the transaction number that was given by eCollect® when web service createTransaction was consumed. Yes <getTransactionInformation xmlns="http://www.avisortech.com/eCollect®Webservices"> <request> <EntityCode>string</EntityCode> <TicketId>string</TicketId> </request> </getTransactionInformation> getTransactionInformation Response getTransactionInformationResponseType Name Type Description Transaction Information (Original Fields) EntityCode String Internal entity code given by Avisor Technologies. TransValue Decimal Value to pay without Taxes. Value processed by Financial Institution in the currency described in “PayCurrency”. Required Yes Yes Format: 99999.99 Max decimals: 2 Decimal separator: . (point) www.e-collect.com 11 eCollect® Technical Guide February 2008 Version 3.32 TransVatValue Decimal Total Taxes. Value processed by Financial Institution in the currency described in “PayCurrency”. Yes Format: 99999.99 Max decimals: 2 Decimal separator: . (point) Payment References (Array) Reference1 String1to20 Reference2 String1to20 Reference3 String1to20 Reference4 String1to80 Reference5 String1to80 Reference6 String1to80 Reference-n String1to80 Transaction Information (New Fields) TranState String Identify the buyer. Additional payment information. Additional payment information. Additional payment information. Additional payment information. Additional payment information. Additional payment information. Yes No No No No No No Final Transaction State. See table below. Yes BankProcessDate Date Date when this transaction was resolved by the Financial Institution. Yes BankName String1to30 Financial Institution transaction. this Yes TrazabilityCode String1to10 Unique number given by the Financial Institution that processed this transaction. It can be shows as transaction confirmation number to customers. Payment method used to pay. Yes that processed PaymentSystem String1to5 ReturnCode String Indicates if the web service requests was successful or not, see possible Return Codes below. Yes TicketId Integer1to10 Identifies the transaction number that was created on eCollect® for this request. Yes PayCurrency String1to3 No CurrencyRate Decimal Corresponding country currency code as TransValue and TransVatValue are represented in. ISO 4217. This is the currency what transaction was processed in the Financial Institution. Money exchange rate applied for this buying. No Format: 99999.99 www.e-collect.com 12 eCollect® Technical Guide February 2008 Version 3.32 Max decimals: 2 Decimal separator: . (point) RetriesTicketId (Array) If transaction retries features is enabled, eCollect will return an array of all tries and their states. TicketId TranState Integer1to10 String Transaction number of each try. Transaction state of the each try. www.e-collect.com 13 eCollect® Technical Guide February 2008 Version 3.32 getTransactionInformationResponseType Name Type Description Required <getTransactionInformationResponse> <getTransactionInformationResult> <EntityCode>string</EntityCode> <TicketId>string</TicketId> <TrazabilityCode>string</TrazabilityCode> <TranState>string</TranState> <ReturnCode>string</ReturnCode> <TransValue>decimal</TransValue> <TransVatValue>decimal</TransVatValue> <PayCurrency>string</PayCurrency> <CurrencyRate>decimal</CurrencyRate> <BankProcessDate>date</BankProcessDate> <BankName>string</BankName> <PaymentSystem>string</PaymentSystem> <ReferenceArray>string</ReferenceArray> <ReferenceArray>string</ReferenceArray> <AuthReferenceArray> <string>string</string> <string>string</string> </AuthReferenceArray> <RetriesTicketId> <TicketId>string</TicketId> <TranState>string</TranState> </RetriesTicketId> <RetriesTicketId> <TicketId>string</TicketId> <TranState>string</TranState> </RetriesTicketId> </getTransactionInformationResult> </getTransactionInformationResponse> www.e-collect.com 14 eCollect® Technical Guide February 2008 Version 3.32 ReturnCode State SUCCESS FAIL_INVALIDENTITYCODE FAIL_INVALIDTICKETID Description The request was process successfully. The EntityCode field does not exist, is null or blank. The TicketId field is does not exists, is null or blank. 5. Transaction States When a response is sent by eCollect® it means that this transaction has been resolved by the Financial Institution, in other word, this transaction has finished and will not change its state. State OK Description Transaction was AUTHORIZED by Financial Institution. NOT_AUTHORIZED Transaction was NOT AUTHORIZED by Financial Institution. EXPIRED Transaction EXPIRED waiting for customer action before going to Financial Institution. Customer never went to Financial Institution. It occurs when customer close the web browser before choosing a Financial Institution or when customer didn’t made any action on this page and web application session expired. FAILED There was a technical fail trying to process this transaction in the Financial Institution. BANK PENDING The customer has begun authorization process with the financial institution, but it has not confirmed the transaction yet. www.e-collect.com 15 eCollect® Technical Guide May 2009 Version 3.36 Contents 1. Escenarios para Resolver Transacciones en eCollect _________________________ 3 Escenario 1: Resolver transacción en proceso normal. __________________________________ 3 Escenario 2 - Resolver transacción sin sesión de Cliente. ________________________________ 4 Escenario 3 - Resolver transacción por demanda. _______________________________________ 5 www.avisortech.com Bogotá, Colombia: Phone (57) 1 3458833 (57) 1 4937039 2 eCollect® Technical Guide May 2009 Version 3.36 1. Escenarios para Resolver Transacciones en eCollect Escenario 1: Resolver transacción en proceso normal. Cuando el proceso de pago fluye de manera normal sin ser interrumpido en ninguno de los pasos. www.avisortech.com Bogotá, Colombia: Phone (57) 1 3458833 (57) 1 4937039 3 eCollect® Technical Guide May 2009 Version 3.36 Escenario 2 - Resolver transacción sin sesión de Cliente. Este proceso asegura que siempre se resuelva la transacción cuando se interrumpe el proceso una vez la transacción ha iniciado la autorización en la Entidad Financiera, esto puede suceder por caídas de internet del Cliente o cuando cierra la ventana en la Entidad Financiera. Existen implementados procesos en background para resolver este escenario. NOTA: Se recomienda manejar un parámetro de TimeOut que inicialmente se puede configurar en 7minutos, antes de incluir una transacción dentro del proceso de Background. www.avisortech.com Bogotá, Colombia: Phone (57) 1 3458833 (57) 1 4937039 4 eCollect® Technical Guide May 2009 Version 3.36 Escenario 3 - Resolver transacción por demanda. Este proceso resuelve las transacciones que tenga pendiente el Cliente cuando éste ingresa nuevamente al portal de LA EMPRESA antes que el proceso en background, descrito anteriormente, lo haya resuelto. Esta alternativa le proporciona al Cliente una estado real de su transacción y crea confianza en la solución. www.avisortech.com Bogotá, Colombia: Phone (57) 1 3458833 (57) 1 4937039 5