Sign@ture Server 2.

3
Descripcin de servicios web (XML Web
Services)

South Consulting Signature S.A

 Av. Del Valle 961, Of. 4704 - Huechuraba, Ciudad Empresarial - Santiago, Chile.
Tel. (56-2) 594 6900 Fax. (56-2) 594 6921
www.southconsulting.com

Documento Confidencial

Sign@ture Server - Descripcin Web Services

ndice de Contenidos
NDICE DE CONTENIDOS ................................................................................. 2
INTRODUCCIN ............................................................................................... 3
SERVICIOS DISPONIBLES................................................................................ 4
ESTRUCTURA MENSAJE DE RESPUESTA ..................................................................................... 5
MTODO SENDDOCUMENTS () ............................................................................................. 6
MTODO RECOVERDOCUMENT () .......................................................................................... 7
MTODO RECOVERRECEIVEDDOCUMENT () ............................................................................... 8
MTODO RECEIVEDOCUMENTS () ......................................................................................... 9
MTODO CONFIRMDOCUMENTRECEPTION () ............................................................................. 9
MTODO SEARCHSENTDOCUMENTS () .................................................................................. 10
MTODO SEARCHRECEIVEDDOCUMENTS () ............................................................................. 11
MTODO DOCUMENTINFO() .............................................................................................. 12
MTODO DOCUMENTTRACKING() ........................................................................................ 13

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Introduccin
El presente documento tiene como objetivo describir los mtodos expuestos por el
Servicio Web del Sign@ture Server. El consumo de estos mtodos va a permitir la
integracin de softwares de terceros con la plataforma Sign@ture va Servicio Web
XML.

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Servicios disponibles
Sign@ture Server provee servicios WEB que pueden ser accedido desde la URL:
http://server_name/Sign@webservices/Core.asmx donde server_name es el
nombre o la direccin IP del servidor donde se encuentra instalado Sign@ture Server.
Si se desea obtener la descripcin (WSDL) del Web Service puede hacerse a travs de
la URL http://server-name/Sign@webservices/Core.asmx?WSDL.
Los mtodos disponibles son:


SendDocuments ()

RecoverDocument ()

RecoverReceivedDocument ()

ReceiveDocuments ()

ConfirmDocumentReception ()

SearchSentDocuments ()

SearchReceivedDocuments ()

DocumentInfo ()

DocumentTracking ()

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Estructura mensaje de respuesta

Al invocar cualquiera de los mtodos expuextos por Sign@ture Server Web Service se
obtiene una cadena que representa un XML con la siguiente estructura:

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo SendDocuments ()
Este mtodo permite enviar documentos electrnicos a Sign@ture Server, los
documentos tienen que pertenecer al grupo de documentos Enviados (Emitidos).
Descripcin de Parmetros
SendDocuments(string Subscriber, string UserName, string Password, string xml)
Parmetro

Descripcin

Validacin

Suscriber

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) emisora de
los Documentos.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.

UserName

Nombre del usuario.

Debe ser un usuario creado en

Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Password

Contrasea asociada al
usuario.

xml

Cadena que representa

documento XML .

South Consulting Signature

Mejorando los Procesos de Negocio

La cadena debe representar un

documento XML que se
corresponda con el esquema de
documentos definidos en la
localizacin.

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo RecoverDocument ()
Este mtodo permite recuperar documentos electrnicos emitidos (Documentos
Enviados) almacenados en Sign@ture Server.
Descripcin de Parmetros
RecoverDocument (string Subscriber, string UserName, string Password, string
DocumentType, long DocumentNumber, string Format)
Parmetro

Descripcin

Validacin

Suscriber

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) emisora de
los Documentos.

Cdigo correspondiente a una

empresa creada en Sign@Ture
Server.

UserName

Nombre del usuario.

Debe ser un usuario creado en

Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Password

Contrasea asociada al
usuario.

DocumentType

Tipo del documento.

DocumentNumber

Folio del documento

Format

Formato en que se desea

recuperar el documento.

Cdigos de tipos de documentos

definidos en la localizacin.


xml: Formato xml.

pdfg: Formato pdf generado

con plantilla grfica.

pdft: Formato pdf generado

con la plantilla texto.

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo RecoverReceivedDocument ()
Este mtodo permite recuperar documentos electrnicos recibidos (Documentos
Recibidos) almacenados en Sign@ture Server.
Descripcin de Parmetros
RecoverReceivedDocument(string Subscriber, string UserName, string Password,
string Sender, string DocumentType, long DocumentNumber, string Format)
Parmetro

Descripcin

Validacin

Suscriber

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) receptora de
los Documentos.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.

UserName

Nombre del usuario.

Debe ser un usuario creado en

Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Password

Contrasea asociada al
usuario.

Sender

DocumentType

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) emisora de
los Documentos.
Tipo del documento.

DocumentNumber

Folio del documento

Format

Formato en que se desea

recuperar el documento.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Cdigos de tipos de documentos
definidos en la localizacin.


xml: Formato xml.

pdfg: Formato pdf generado

con plantilla grfica.

pdft: Formato pdf generado

con la plantilla texto.

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo ReceiveDocuments ()
Este mtodo permite recuperar documentos electrnicos recibidos (Documentos
Recibidos) almacenados en Sign@ture Server y que esten pendientes de descarga
desde la plataforma .
Descripcin de Parmetros
ReceiveDocuments(string Subscriber, string UserName, string Password)
Parmetro

Descripcin

Validacin

Suscriber

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) receptora de
los Documentos.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.

UserName

Nombre del usuario.

Debe ser un usuario creado en

Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Password

Contrasea asociada al
usuario.

Mtodo ConfirmDocumentReception ()
Este mtodo permite confirmar la recepcin de un documento electrnico en
Sign@ture Server .
Descripcin de Parmetros
ConfirmDocumentReception(string Subscriber, string UserName, string Password, long
IdDocument)
Parmetro
Descripcin
Validacin
Suscriber

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) a la que
esta asociado el Documento.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.

UserName

Nombre del usuario.

Debe ser un usuario creado en

Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Password

Contrasea asociada al
usuario.

IdDocument

Identificador del Documento en

la plataforma.

South Consulting Signature

Mejorando los Procesos de Negocio

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo SearchSentDocuments ()
Este mtodo permite recuperar documentos electrnicos emitidos (Documentos
Enviados) almacenados en Sign@ture Server en correspondencia con criterios
avanzados que se especifican como parmetros.
Descripcin de Parmetros
SearchSentDocuments ( string Subscriber, string UserName, string Password,
string
DocumentType,
short
TopN,
string
Receiver,
long
NumberFrom,
long NumberTo, DateTime DateFrom, DateTime DateTo, decimal AmountFrom,
decimal AmountTo, string DivisionCode)
Parmetro
Suscriber

UserName

Password
DocumentType
TopN
Receiver

NumberFrom

NumberTo

DateFrom

DateTo

AmountFrom

AmountTo

DivisionCode

Descripcin

Validacin

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) emisora del
Documento.
Nombre del usuario.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Debe ser un usuario creado en
Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Contrasea asociada al
usuario.
Tipo del documento.
Mximo de Documentos a
recuperar.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) receptora
del Documento.
Lmite inferior del rango de
folios de documentos que se
quiere recuperar.
Lmite superior del rango de
folios de documentos que se
quiere recuperar.
Lmite inferior del rango de
fecha de documentos que se
quiere recuperar.
Lmite superior del rango de
fecha de documentos que se
quiere recuperar.
Lmite inferior del rango de
monto de documentos que se
quiere recuperar.
Lmite superior del rango de
monto de documentos que se
quiere recuperar.
Identificador de la Divisin a la
que esta asociada el
documento en la plataforma

South Consulting Signature

Mejorando los Procesos de Negocio

Cdigos de tipos de documentos

definidos en la localizacin.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.

10

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo SearchReceivedDocuments ()
Este mtodo permite recuperar documentos electrnicos recibidos (Documentos
Recibidos) almacenados en Sign@ture Server en correspondencia con criterios
avanzados que se especifican como parmetros.
Descripcin de Parmetros
SearchReceivedDocuments( string Subscriber, string UserName, string Password,
string DocumentType, short TopN, string Sender, long NumberFrom, long NumberTo,
DateTime DateFrom, DateTime DateTo, decimal AmountFrom, decimal AmountTo,
string DivisionCode)
Parmetro
Suscriber

UserName

Password
DocumentType
TopN
Sender

NumberFrom

NumberTo

DateFrom

DateTo

AmountFrom

AmountTo

DivisionCode

Descripcin

Validacin

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) a la que
esta asociado el Documento.
Nombre del usuario.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Debe ser un usuario creado en
Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

Contrasea asociada al
usuario.
Tipo del documento.
Mximo de Documentos a
recuperar.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) emisora del
Documento.
Lmite inferior del rango de
nmero de documentos que se
quiere recuperar.
Lmite superior del rango de
folios de documentos que se
quiere recuperar.
Lmite inferior del rango de
fecha de documentos que se
quiere recuperar.
Lmite superior del rango de
fecha de documentos que se
quiere recuperar.
Lmite inferior del rango de
monto de documentos que se
quiere recuperar.
Lmite superior del rango de
monto de documentos que se
quiere recuperar.
Identificador de la Divisin a la
que esta asociada el
documento en la plataforma

South Consulting Signature

Mejorando los Procesos de Negocio

Cdigos de tipos de documentos

definidos en la localizacin.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.

11

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo DocumentInfo()
Este mtodo permite recuperar informacin
almacenados en Sign@ture Server.

de

los

documentos

electrnicos

Descripcin de Parmetros
DocumentInfo(string Subscriber, string UserName, string Password, string Sender,
string DocumentType, long DocumentNumber)
Parmetro
Suscriber

UserName

Password

Descripcin

Validacin

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) a la que
esta asociado el Documento.
Nombre del usuario.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Debe ser un usuario creado en
Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

DocumentType

Contrasea asociada al
usuario.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) emisora del
Documento.
Tipo del documento.

DocumentNumber

Nmero del Documento.

Sender

South Consulting Signature

Mejorando los Procesos de Negocio

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Cdigos de tipos de documentos
definidos en la localizacin.

12

Documento Confidencial

Sign@ture Server - Descripcin Web Services

Mtodo DocumentTracking()
Este mtodo permite recuperar el histrico de los cambios de estado de los
documentos electrnicos almacenados en Sign@ture Server.
Descripcin de Parmetros
DocumentTracking(string Subscriber, string UserName, string Password, string
Sender, string DocumentType, long DocumentNumber)
Parmetro
Suscriber

UserName

Password

Descripcin

Validacin

Cdigo de empresa (RUT, RFC,

CNPJ, CUIT, etc..) a la que
esta asociado el Documento.
Nombre del usuario.

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Debe ser un usuario creado en
Sign@ture Server y asociado al
Suscriber, este usuario podr
tener cualquier perfil.

DocumentType

Contrasea asociada al
usuario.
Cdigo de empresa (RUT, RFC,
CNPJ, CUIT, etc..) emisora del
Documento.
Tipo del documento.

DocumentNumber

Nmero del Documento.

Sender

Cdigo correspondiente a una

empresa creada en Sign@ture
Server.
Cdigos de tipos de documentos
definidos en la localizacin.

Sobre South Consulting Signature:

South Consulting Signature es la empresa consultora lder en proveer soluciones de Facturacin Electrnica para clientes de todas las industrias
en el mercado local y regional, con el fin de mejorar sus procesos de negocio. South Consulting Signature es pionera en desarrollo de software
e integracin de aplicaciones, entregando soluciones a requerimientos especficos, que permiten el mximo aprovechamiento de los recursos
disponibles de los clientes. Est presente en Chile y Mxico y muy pronto extender sus operaciones a Brasil, Argentina y Estados Unidos.
South Consulting Signature. Todos los derechos reservados.

South Consulting Signature

Mejorando los Procesos de Negocio

13