You are on page 1of 34

Especificacin WebService para:

Bandeja de salida
Carga masiva
Consulta de reportes

Bogot, Diciembre 2010

Modelo Unico de Ingresos, Servicio y Control Automatizado

Contenido

Procedimiento y Especificacin Tcnica para la Bandeja de Salida ..................................................... 1


Presentacin de Informacin por Envo de Archivos a travs de Web Service .................................. 10
Procedimiento y Especificacin Tcnica para la Consulta de Reportes ............................................. 29

Procedimiento y Especificacin Tcnica para la Bandeja de Salida

El objetivo de la siguiente especificacin tcnica es brindar la informacin detallada a las entidades


competentes, para que puedan acceder a la Bandeja de Salida a travs de Web Services ofrecidos por
la DIAN.

Definicin de los casos de uso para la Bandeja de Salida a travs de Web Services
Los siguientes son los casos de uso de las operaciones que podrn utilizar las personas u organizaciones:
Obtener las URLs del servicio web y del servlet para acceder a la bandeja de salida.
Consultar el nmero de documento que representa una salida de informacin por envo de archivos.
Consultar el listado de archivos que pertenecen a una salida de informacin por envo de archivos.
Descargar archivos desde la bandeja de salida.
A continuacin se definen cada uno de los casos de uso como operaciones de los Web Services y
operaciones ofrecidas por el servlet.

1. Web Service - Preguntar URLs


Este servicio Web posee autenticacin y por tal razn es necesario ver el apartado de configuracin
de seguridad, donde se explica cmo se maneja este tema por medio del Header del mensaje SOAP
(ver especificacin wsdl DWSPreguntarURLBandejaSalida.wsdl).
1.1. Obtener las URLs del servicio web para las opciones de bandeja de salida y del servlet
para la descarga de archivos
Nombre operacin

getURLsBSA

DESCRIPCIN

Permite obtener la url del servicio web que va a atender las peticiones de
correspondientes al WebService - Acceder Bandeja de Salida, y la url del
servlet que permite descargar archivos.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

formato

Formato del cual va a realizar la consulta


o descarga de archivos.

int

PARMETROS DE SALIDA

Nombre

Descripcin

Tipo de dato o
Elemento XSD

getURLsBSAReturn

XML que contiene las urls del


servlet y del web server.

getURLsBSA.xsd

2. Web Service Acceder Bandeja de Salida


Este servicio Web posee autenticacin y por tal razn es necesario ver el apartado de configuracin
de seguridad, donde se explica cmo se maneja este tema por medio del Header del mensaje SOAP
(ver especificacin wsdl DWSConsultarDocSalidaInfo.wsdl ).
Adems, este servicio Web implemente WSS (Web Service Security), por lo que hay que tener en
cuenta el callBack que firma el mensaje SOAP. Ver configuracin de seguridad.

2.1. Consultar documento salida de informacin


Nombre operacin

consultarDocumentoSalida

DESCRIPCIN

Permite consultar el nmero de documento de una salida de


informacin (documento con formato 10606), dado un identificador que
representa el origen de la salida de informacin.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

identificadorOrigen

Identificador que representa


el origen de la salida de
informacin.

string

Nombre

Descripcin

Tipo de dato o
Elemento XSD

consultarDocumentoSalidaReturn

Elemento XML que contiene el


nmero de documento de la
salida de informacin
(documento con formato
10606).

consultarDocumentoSalida.xsd

PARMETROS DE SALIDA

2.2. Consultar archivos de salida

Nombre

operacin consultarArchivosSalida

DESCRIPCIN

Permite consultar el nombre e identificador de los archivos que pertenecen a


una salida de informacin, dado un documento con formato 10606 que
representa la salida de informacin.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

numero Solicitud

Documento con formato


10606 que representa la
salida de informacin.

long

Descripcin

Tipo de dato o
Elemento XSD

PARMETROS DE SALIDA
Nombre

consultarArchivosSalidaReturn Elemento XML que contiene el


nombre y el id de los archivos
que pertenecen a una salida
de informacin.

consultarArchivosSalida.xsd

3. Servlet Manejo de Archivos


El servlet posee autenticacin y por tal razn es necesario ver el apartado de configuracin de
seguridad, donde se explica cmo se maneja este tema por medio del Header del Request. Por tal
razn la comunicacin se hace a travs de HTTPS.
Para determinar qu operacin se desea ejecutar, es necesario enviar el parmetro operacin, con
la operacin correspondiente.
3.1. Descargar archivos de salida
Nombre operacin
DESCRIPCIN

Descargar Archivo de Salida


Permite descargar un archivo de la bandeja de salida.

PARMETROS DEL HEADER


Nombre

Valor

Descripcin

tipoIdentificacion

Cdigo del tipo de identificacin.


Ver configuracin de seguridad.

identificacin

Numero de Identificacin. Ver configuracin de


seguridad.

tipoOrganizacion

Cdigo del tipo de organizacin. Ver configuracin de


seguridad.

nitOrganizacion

NIT de la Organizacin, si se autntica a nombre de


una. Ver configuracin de seguridad.

password

La contrasea va codificada con UTF-8. Ver


configuracin de seguridad.

PARMETROS DEL GET DEL REQUEST


Nombre

Valor

Descripcin

operacion

Operacin que permite la descarga de archivos.

numeroSolicitud

long

Documento con formato 10606 que representa la


salida de informacin.

idArchivo

int

Identificador del archivo que se va a descargar.

Valor

Descripcin

stream

A travs del stream, enva el archivo, el cual es un


comprimido cuyo nombre es el id del archivo con
extensin zip, y contiene el archivo solicitado cuyo
nombre y extensin depende de cmo est registrado.
Si se presento algn error, devuelve por este mismo
medio, un xml con el error.

Respuesta servlet
archivos.xsd

Si se present algn error, devuelve por este mismo


medio en vez del archivo, un xml con el error.

RESPUESTA
Nombre

Configuracin de Seguridad

IPs autorizadas por la DIAN


El servicio ofrecido debe contar con una direccin pblica vlida en Internet para poder consumir las
operaciones de los Web Services ofrecidos por carga Masiva. Esta direccin debe ser informada a la
DIAN para su autorizacin. Solamente desde las direcciones autorizadas se podr acceder a estas
operaciones.

Protocolo HTTPS
El protocolo de comunicacin establecido para conectarse al Web Service y al servlet de la DIAN es
HTTPS.

Certificados Digitales
Los certificados digitales que se utilizarn para validar el mensaje SOAP deben ser emitidos por una
Entidad Certificadora autorizada por la Superintendencia de Industria y Comercio.
Estos certificados deben ser de tipo Servidor Seguro que permitan generar firmas automatizadas.

WS-Security
Como mecanismo de seguridad para el envo y recepcin de los mensajes SOAP, se establece el
estndar internacional WS-Security.
Los mensajes SOAP tendrn que cumplir las siguientes caractersticas:

Para la peticin SOAP:


Estar firmado digitalmente.
Contener el elemento Timestamp, el cual indica la fecha y hora en que se crea la peticin, y la
fecha y hora en que expira el mensaje.
Para la autenticacin ante el DIAN se deber usar el elemento accesoMUISCA (que se puede
encontrar en http://muisca.dian.gov.co/ws-eys/xsd/seguridad/accesoMUISCA.xsd) en la cabecera
(Header) del mensaje SOAP. Esta cabecera est definida en el WSDL del Web Service. La
inclusin de este elemento dentro de la cabecera del mensaje SOAP vara dependiendo de la
plataforma usada. Este elemento usa los siguientes atributos para permitir el acceso a DIAN:
-

tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de


organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.

Un ejemplo es el siguiente:

<soapenv:Header>
<ns1:accesoMUISCA xmlns:ns1=http://www.dian.gov.co/ws/seguridad
soapenv:actor=http://schemas.xmlsoap.org/soap/actor/next soapenv:mustUnderstand=0"
ns1:tipoOrganizacion=NIT_ORGANIZACION ns1:nitOrganizacion=99999999"
ns1:tipoIdentificacion=SISns1:identificacion=99999999"
ns1:password=XXXXXX></ ns1:accesoMUISCA>
</soapenv:Header>

Para la Respuesta SOAP:


El mensaje SOAP deber estar firmado digitalmente.
Contendr el elemento Timestamp.

Autenticacin va Servlet
Para la autenticacin ante el DIAN a travs del servlet, se deben utilizar los siguientes parmetros,
que viajarn por header del request:
tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.

Presentacin de Informacin por Envo de Archivos a travs de Web Service

El servicio de presentacin de informacin por envo de archivos a travs de web service (sistema a
sistema), permite de manera general a los usuarios del mismo, las siguientes opciones:
Realizar una solicitud de carga de archivos,
Consultar el estado del procesamiento de la solicitud,
Recibir la comunicacin respectiva cuando se finalice el procesamiento.

En forma detallada a travs del nuevo servicio, podrn realizarse las siguientes operaciones, bien sea
que se trate de personas u organizaciones:
Preguntar URLs.
Reservar nmeros de documentos.
Obtener el rango de consecutivos para los archivos a cargar.
Presentar solicitud de envo de archivos.
Consultar el estado de la solicitud.
Consultar archivos de la bandeja de entrada.
Eliminar archivos de la bandeja de entrada.
Colocar archivos en la bandeja de entrada.
Colocar los archivos con error de una solicitud en la bandeja de salida.
Descargar los archivos con error de una solicitud de la bandeja de salida.

Los siguientes son las operaciones que deben implementar las personas u organizaciones para recibir
respuesta relacionada con el procesamiento de solicitudes:
Informar fin de procesamiento de una solicitud de envo de archivos.
Informar fin de colocacin de archivos de error en la bandeja de salida.

10

A continuacin se definen cada una de las operaciones de los Web Services as como de las operaciones
ofrecidas por el servlet.

11

1. Web Service DIAN Preguntar URLs


Esta operacin Web posee autenticacin y por tal razn es necesario ver el apartado de configuracin
de seguridad, donde se explica cmo se maneja este tema por medio del Header del mensaje SOAP
(ver especificacin wsdl DWSPreguntarURL.wsdl).
1.1. Obtener las URLs del servicio Web para las opciones de envo masivo y del servlet para
carga y descarga de archivos

Nombre Operacin

getURLs

DESCRIPCIN

Permite obtener la URL del servicio Web que va a atender las


peticiones correspondientes al WebService Presentar Solicitud, y
la URL del servlet que permite cargar y descargar archivos.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

formato

Formato del cual va a realizar


la solicitud de carga de
archivos.

int

Nombre

Descripcin

Tipo de dato o
Elemento XSD

getURLsReturn

XML que contiene las urls del servlet


y del web server.

getURLs.xsd

PARAMETROS DE SALIDA

12

2. Web Service DIAN Presentar Solicitud


Esta operacin Web posee autenticacin y por tal razn es necesario ver el apartado de configuracin
de seguridad, donde se explica cmo se maneja este tema por medio del Header del mensaje SOAP
(ver especificacin wsdl DWSPresentarSolicitud.wsdl).
Adems, esta operacin Web implica implementar WSS (Web Service Security), por lo que hay que
tener en cuenta el callBack que firma el mensaje SOAP. Ver configuracin de seguridad.
2.1. Reservar nmeros de documentos

Nombre Operacin

reservarNumerosDocumento

DESCRIPCIN

Permite reservar una numeracin de consecutivos que como mnimo


debera ser la misma cantidad de archivos a cargar.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

cantidadConsecutivos

Cantidad de nmeros de
documentos que se desean
reservar.

int

formato

Formato para el cual se requiere


reservar nmero de documentos.

int

version

Versin del formato para el cual


se requiere reservar nmero de
documentos

int

Nombre

Descripcin

Tipo de dato o
Elemento XSD

reservarNumeros
DocumentoReturn

XML con los nmeros de


documentos reservados.

reservarNumerosDocumento.xsd

PARMETROS DE SALIDA

13

2.2. Obtener el rango de consecutivos para los archivos a cargar

Nombre Operacin

consultarRangoConsecutivos

DESCRIPCIN

Permite reservar una numeracin de consecutivos que como mnimo


debera ser la misma cantidad de archivos a cargar.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

cantidadConsecutivos

Cantidad de consecutivos para los


cuales va a reservar numeracin.

int

formato

Formato para el cual se requiere


reservar consecutivos.

int

version

Versin del formato para el cual


se requiere reservar
consecutivos.

int

Nombre

Descripcin

Tipo de dato o
Elemento XSD

consultarRango
ConsecutivosReturn

XML con el rango de consecutivos


reservados.

consultarRangoConsecutivos.xsd

PARMETROS DE SALIDA

14

2.3. Presentar solicitud de envo de archivos

Nombre Operacin

presentarSolicitud

DESCRIPCIN

Permite presentar una solicitud para el envo de uno o varios archivos


colocados previamente en la bandeja de entrada de la persona u
organizacin.

PARAMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

xmlDocSolicitud

XML que contiene la informacin de


la solicitud de envo de archivo (ver
Anexo A).

xmlDocSolicitud.xsd

Nombre

Descripcin

Tipo de dato o
Elemento XSD

reservarNumeros
DocumentoReturn

XML que contiene la informacin


del acuse de recibo.

presentarSolicitud.xsd

PARAMETROS DE SALIDA

15

2.4. Consultar el estado de la solicitud


Nombre Operacin

consultarSolicitud

DESCRIPCIN

Permite consultar el estado de la solicitud, y lista el nombre de los


archivos que presentaron error. Esta operacin tendr polticas para
poder utilizada cada cierto tiempo.

PARAMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

numeroSolicitud

Nmero de la solicitud sobre la


que se desea hacer la consulta.

long

Nombre

Descripcin

Tipo de dato o
Elemento XSD

consultarSolicitudReturn

XML que contiene el estado de la


solicitud; si la solicitud present
errores, incluye el listado de los
archivos que tuvieron error.

consultarSolicitud.xsd

PARAMETROS DE SALIDA

16

2.5. Colocar los archivos con error de una solicitud en la bandeja de salida
Nombre operacin

colocarArchivosBandejaSalida

DESCRIPCIN

Permite colocar en la bandeja de salida los archivos que presentaron error


durante el procesamiento, de manera comprimida. Esta operacin es
asincrnica, lo que hace que se genere una respuesta usando el Web
Service implementado por la organizacin para informar el fin de
colocacin de archivos de error. Para la descarga posterior de los archivos
de error, se deben utilizar los Web Services ofrecidos por la bandeja de
salida para consultar el nmero de la solicitud de descarga (10606) y un
identificador de archivo a partir del documento de la solicitud de
presentacin de informacin por envo de archivos (10006). Luego a
travs del Servlet de la bandeja de salida, se podr descargar el archivo,
el cual es un zip cuyo nombre va a ser el mismo nmero de la solicitud de
envo de archivos, y contendr los XML de los archivos que presentaron
error durante el procesamiento de la solicitud de envo de archivos.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

numeroSolicitud

Nmero de la solicitud, de la cual


se desea colocar los archivos de
error a la bandeja de salida.

long

PARMETROS DE SALIDA

17

Nombre

Descripcin

Tipo de dato o
Elemento XSD

colocarArchivosBandeja
SalidaReturn

XML que contiene el estado de


xito o los errores de la operacin.

colocarArchivosBandejaSalida.xsd

` 2.6. Consultar archivos de la bandeja de entrada

Nombre Operacin

consultarArchivosBandejaEntrada

DESCRIPCIN

Permite consultar el nombre de los archivos que se encuentran en la


bandeja de entrada, filtrados por formato y versin.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

formato

Formato para el cual se van a


consultar los archivos.

int

version

Versin del formato para el cual


se van a consultar los archivos.

int

Nombre

Descripcin

Tipo de dato o
Elemento XSD

consultarArchivosBandeja
EntradaReturn

XML que contiene el nombre de


los archivos que se encuentran en
la bandeja de entrada, filtrados
por formato y versin segn los
parmetros del web service.

consultarArchivosBandejaEntrada.xsd

PARAMETROS DE SALIDA

18

2.7. Eliminar archivos de la bandeja de entrada

Nombre Operacin

eliminarArchivosBandejaEntrada

DESCRIPCIN

Permite eliminar archivos que se encuentran en la bandeja de entrada.

PARMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

xmlNomArchivos

XML que contiene el nombre de los


archivos a eliminar de la bandeja de
entrada.

xmlNomArchivos.xsd

PARMETROS DE SALIDA

19

Nombre

Descripcin

Tipo de dato o
Elemento XSD

eliminarArchivoBandeja
EntradaReturn

XML que contiene el nombre de los


archivos y el estado del proceso de
eliminacin de cada uno.

eliminarArchivoBandejaEntrada.xsd

3. Servlet DIAN Manejo de Archivos


El servlet posee autenticacin y por tal razn es necesario ver el apartado de configuracin de seguridad,
donde se explica cmo se maneja este tema por medio del Header del Request. Por tal razn la
comunicacin se hace a travs de HTTPS.
Para determinar qu operacin se desea ejecutar, es necesario enviar el parmetro operacin, con la
operacin correspondiente.

3.1. Colocar archivos en la bandeja de entrada


Nombre Operacin

Colocar Archivo en la Bandeja de Entrada

DESCRIPCIN

Permite colocar el archivo a cargar en la bandeja de entrada, en


formato XML o comprimido con varios archivos XML en su contenido.

PARAMETROS EN EL HEADER DEL REQUEST


Nombre

Valor

Descripcin

tipoIdentificacion

Cdigo del tipo de identificacin. Ver


configuracin de seguridad.

identificacion

Nmero de Identificacin. Ver configuracin


de seguridad.

tipoOrganizacion

Cdigo del tipo de organizacin. Ver


configuracin de seguridad.

nitOrganizacion

NIT de la Organizacin, si se autntica a


nombre de una. Ver configuracin de
seguridad.

password

La contrasea va codificada con UTF-8. Ver


configuracin de seguridad.

20

PARAMETROS EN EL GET DEL REQUEST


Nombre

Valor

Descripcin

operacion

Operacin que permite la carga de archivos.

nombreArchivo

Dmuisca_ccmmmmmv
vaaaacccccccc.xml
o
Dmuisca_ccmmm
mmvvaaaacccccccc.zip
o
signDmuisca_ccmmmmmv
vaaaacccccccc.xml.xml

Dmuisca_ccmmmmmv
vaaaacccccccc.xmlcc:
Concepto (Insercin = 01 Reemplazo =
02).mmmmm: Formato.vv: Versin del
formato.aaaa: Ao de envo.cccccccc :
Consecutivo de envo por ao.

PARAMETROS EN EL POST DEL REQUEST


Nombre

Valor

Descripcin

A travs del stream del request, enva el


archivo.
PARAMETROS EN EL RESPONSE
Nombre

Valor

Descripcin

Respuesta servlet archivos.xsd A travs del stream del response, se enva


un xml el estado de los archivos que se
cargaron y/o se descomprimieron.

21

4. Web Service Organizacin Respuestas de Procesamiento


4.1. Informar fin de procesamiento de una solicitud de envo de archivos
Para esta operacin, revisar la especificacin tcnica de WebService Para consulta de Reportes
(ver especificacin Especificacin de WebService Para consulta de Reportes.doc). La respuesta
est definida bajo el siguiente esquema: informarFinProcesamientoSolicitud.xsd
4.2. Informar fin de colocacin de archivos de error en la bandeja de salida
Para esta operacin, revisar la especificacin tcnica de WebService Para consulta de Reportes
(ver especificacin Especificacin de WebService Para consulta de Reportes.doc). La respuesta
est definida bajo el siguiente esquema: informarFinProcesamientoSolicitud.xsd

Configuracin de Seguridad
IPs autorizadas por la DIAN
El servicio ofrecido debe contar con una direccin pblica vlida en Internet para poder consumir las
operaciones de los Web Services ofrecidos por carga Masiva. Esta direccin debe ser informada a la
DIAN para su autorizacin. Solamente desde las direcciones autorizadas se podr acceder a estas
operaciones.
Protocolo HTTPS
El protocolo de comunicacin establecido para conectarse al Web Service y al servlet de la DIAN es
HTTPS.
Certificados Digitales
Los certificados digitales que se utilizarn para validar el mensaje SOAP deben ser emitidos por una
Entidad Certificadora autorizada por la Superintendencia de Industria y Comercio.
Estos certificados deben ser de tipo Servidor Seguro que permitan generar firmas automatizadas.
WS-Security
Como mecanismo de seguridad para el envo y recepcin de los mensajes SOAP, se establece el
estndar internacional WS-Security.
Los mensajes SOAP tendrn que cumplir las siguientes caractersticas:

22

Para la peticin SOAP:


Estar firmado digitalmente.
Contener el elemento Timestamp, el cual indica la fecha y hora en que se crea la peticin, y la
fecha y hora en que expira el mensaje.
Para la autenticacin ante el DIAN se deber usar el elemento accesoMUISCA (que se puede
encontrar en:
http://muisca.dian.gov.co/ws-eys/xsd/seguridad/accesoMUISCA.xsd) en la cabecera (Header) del
mensaje SOAP. Esta cabecera est definida en el WSDL del Web Service. La inclusin de este
elemento dentro de la cabecera del mensaje SOAP vara dependiendo de la plataforma usada.
Este elemento usa los siguientes atributos para permitir el acceso a DIAN:
- tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
- nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
- tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
- identificacion: Nmero de identificacin del usuario.
- password: Contrasea de acceso a la DIAN.
Un ejemplo es el siguiente:
<soapenv:Header>
...
<ns1:accesoMUISCA xmlns:ns1=http://www.dian.gov.co/ws/seguridad
soapenv:actor=http://schemas.xmlsoap.org/soap/actor/next soapenv:mustUnderstand=0"
ns1:tipoOrganizacion=NIT_ORGANIZACION ns1:nitOrganizacion=99999999"
ns1:tipoIdentificacion=SISns1:identificacion=99999999" ns1:password=XXXXXX></
ns1:accesoMUISCA>
</soapenv:Header>

Para la Respuesta SOAP:


El mensaje SOAP deber estar firmado digitalmente.
Contendr el elemento Timestamp.

23

Autenticacin va Servlet
Para la autenticacin ante el DIAN a travs del servlet, se deben utilizar los siguientes parmetros,
que viajarn por el header del request:
tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.

24

Solicitud de Presentacin de Informacin por Envo de Archivos a Travs de WebService

Especificacin tcnica
La solicitud de presentacin de informacin por envo de archivos a travs de WebService, se debe
hacer por medio de un XML que viaja por SOAP y que cumpla las siguientes especificaciones:

1. Formato del XML


El xml de la solicitud esta compuesto por un elemento complejo: Solicitud de envi, el cual se describe
en la tabla 1.
El documento XML debe cumplir con la especificacin 1.0 Tercera edicin.
El conjunto de caracteres utilizado en el documento XML debe ser ISO-8859-1.
El documento XML debe estar bien formado y ser valido de acuerdo al esquema XSD que incluye
en esta especificacin tcnica.

25

El archivo debe contener un elemento nico raz llamado solEnvio, que a su vez contendr toda la
informacin de la solicitud del envi:

Atributo

Casilla

Denominacin
casilla

Tipo

Longitud

Obligatoria

Observaciones

cpt

42

Concepto

int

fmt

40

Cdigo Formato

int

ver

41

Versin Formato

int

anoVig

43

Ao Informado

int

Formato AAAA

perVig

44

Periodo Informado

int

0 = Si es un formato aperidico.

nomArch

46

Nombre y Extensin del


Primer Archivo de Envio.

33

numArch

47

Cantidad de Archivos

int

numReg

48

Nmero Total de
Registros de los
Archivos de Envio.

int

Mximo 50.000 registros y mnimo 1


registro.

numSolAnt

49

long

15

Es obligatoria cuando el atributo cpt es


igual a 2 3.

26

No. de Solicitud
Anterior

string

1 = Insercin
2 = Reemplazo
3 = Reemplazo Parcial

Dmuisca_ccmmmmmvvaaaacccccccc.xml
cc: Concepto (Insercin = 01
Reemplazo = 02).
mmmmm: Formato.
vv: Versin del formato.
aaaa: Ao de envo.
cccccccc: Consecutivo de envo por ao.

Dentro del elemento raz, encontramos otros 3 elementos que se describen a continuacin.
Informacin del interesado
Este elemento nico llamado interesado, contiene la siguiente informacin.

Atributo

Casilla

Denominacion
casilla

Tipo

Longitud

tdoc

25

Tipo de documento de
identificacin

int

nid

26

Nmero del documento


de identificacin

int

12

Obligatoria
S

Observaciones

Cdigos externos obtenidos del dominio 109

Informacin del remitente


Este elemento nico llamado remitente, contiene la siguiente informacin.
Atributo

27

Casilla

Denominacion
casilla

Tipo

Longitud

tdoc

33

Tipo de documento de
identificacin

int

nid

34

Nmero del documento


de identificacin

int

12

Obligatoria
S

Observaciones

Cdigos externos obtenidos del dominio 109

2. Validaciones
Validaciones Generales
El archivo debe contener todos los campos definidos para el encabezado y estos campos deben
estar correctamente diligenciados.
La informacin del contenido del archivo debe corresponder al esquema XSD entregado.
Los atributos que registran valores numricos, se reportan con valores numricos positivos, sin
signos ni puntuaciones, segn lo reportado por el informante o en su defecto con cero (0).
Validaciones en solEnvio
El nmero de la solicitud anterior es requerido si el concepto es reemplazo o reemplazo parcial.

3. Esquema XSD
A continuacin se incluye el esquema XSD para esta especificacin tcnica.
Solicitud de Presentacin de Informacin por Envo De Archivos a Travs de WebService

28

Procedimiento y Especificacin Tcnica para la Consulta de Reportes

El objetivo de la siguiente especificacin tcnica es brindar la informacin detallada a las entidades


competentes, para que puedan acceder a la Consulta de reportes a travs de Web Services ofrecidos
por la DIAN.

Definicin de los casos de uso para la consulta de un reporte a travs de Web Services
Los siguientes son los casos de uso de las operaciones que podrn utilizar las personas u organizaciones:
Consultar un reporte
Recibir la respuesta del reporte
A continuacin se definen cada uno de los casos de uso como operaciones de los Web Services y
operaciones ofrecidas por el servlet.

1. Web Service Consulta Reporte


Este servicio Web posee autenticacin y por tal razn es necesario ver el apartado de configuracin de
seguridad, donde se explica cmo se maneja este tema por medio del Header del mensaje SOAP.
1.1. Consultar el Reporte
Nombre operacin

consultarReporte

DESCRIPCIN

Permite consultar un reporte a partir de los parmetros definidos

Nombre

Descripcin

Tipo de dato o
Elemento XSD

xmlReporteMuisca

Descripcin del nombre del reporte


que se va a consultar y parmetros
que se envan

Reportes.xsd

Nombre

Descripcin

Tipo de dato o
Elemento XSD

idOperacion

Identificador nico de la
solicitud del reporte

String (32 caracteres)

PARAMETROS DE SALIDA

29

2. Web Service Respuesta Servicio


Este servicio Web debe ser implementado por el cliente para recibir la respuesta de alguna operacin
realizada en Muisca y debe ser registrada la URL de respuesta para cada uno de los servicios en la
DIAN. (ver especificacin wsdl (WSRespuestaMuisca.wsdl)
2.1. Respuesta Servicio
Nombre operacin

recibirRespuestaMUISCA

DESCRIPCIN

Enva respuesta a alguna operacin realizada a travs de un servicio


web MUISCA.

PARAMETROS DE ENTRADA
Nombre

Descripcin

Tipo de dato o
Elemento XSD

xmlRespuesta

XML que indica si la


respuesta fue exitosa o no.

RespuestaServicioMuisca.xsd

Configuracin de Seguridad
IPs autorizadas por la DIAN
El servicio ofrecido debe contar con una direccin pblica vlida en Internet para poder consumir las
operaciones de los Web Services ofrecidos por arquitectura. Esta direccin debe ser informada a la
DIAN para su autorizacin. Solamente desde las direcciones autorizadas se podr acceder a estas
operaciones.
Protocolo HTTPS
El protocolo de comunicacin establecido para conectarse al Web Service y al servlet de la DIAN es
HTTPS.
Certificados Digitales
Los certificados digitales que se utilizaran para validar el mensaje SOAP deben ser emitidos por una
Entidad Certificadora autorizada por la Superintendencia de Industria y Comercio.
Estos certificados deben ser de tipo Servidor Seguro que permitan generar firmas automatizadas.

30

WS-Security
Como mecanismo de seguridad para el envo y recepcin de los mensajes SOAP, se establece el
estndar internacional WS-Security.
Los mensajes SOAP tendrn que cumplir las siguientes caractersticas:
Para la peticin SOAP:
Estar firmado digitalmente.
Contener el elemento Timestamp, el cual indica la fecha y hora en que se crea la peticin, y la
fecha y hora en que expira el mensaje.
Para la autenticacin ante el DIAN se deber usar el elemento accesoMUISCA (que se puede
encontrar en: http://muisca.dian.gov.co/ws-eys/xsd/seguridad/accesoMUISCA.xsd) en la cabecera
(Header) del mensaje SOAP. Esta cabecera est definida en el WSDL del Web Service. La inclusin
de este elemento dentro de la cabecera del mensaje SOAP vara dependiendo de la plataforma
usada. Este elemento usa los siguientes atributos para permitir el acceso a DIAN:
- tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
- nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
- tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
- identificacion: Nmero de identificacin del usuario.
- password: Contrasea de acceso a la DIAN.
Un ejemplo es el siguiente:
<soapenv:Header>
...
<ns1:accesoMUISCA xmlns:ns1=http://www.dian.gov.co/ws/seguridad soapenv:actor=http:
/schemas.xmlsoap.org/soap/actor/next soapenv:mustUnderstand=0"
ns1:tipoOrganizacion=NIT_ORGANIZACION ns1:nitOrganizacion=99999999"
ns1:tipoIdentificacion=SISns1:identificacion=99999999" ns1:password=XXXXXX></
ns1:accesoMUISCA>
</soapenv:Header>

31

Para la Respuesta SOAP:


El mensaje SOAP deber estar firmado digitalmente.
Contendr el elemento Timestamp.

Autenticacin va Servlet
Para la autenticacin ante el DIAN a travs del servlet, se deben utilizar los siguientes parmetros,
que viajarn por header del request:
tipoOrganizacion: Tipo de la organizacin que va a realizar la autenticacin. Los tipos de
organizaciones permitidos estn definidos en el XSD.
nitOrganizacion: Corresponde al NIT de la organizacin que va a acceder. Este es requerido
nicamente cuando el tipo de organizacin sea NIT_ORGANIZACION.
tipoIdentificacion: Tipo de documento de identificacin del usuario que solicita el acceso. Los
tipos de documentos de identificacin permitidos estn definidos en el XSD.
identificacion: Nmero de identificacin del usuario.
password: Contrasea de acceso a la DIAN.

32

You might also like