Obtención vía HTTP de los documentos PDF
generados por el servicio de SMS/MMS
certificado.
PDF XML API
LleidaNetworks Serveis Telem`atics, S.L.
[email protected]
Versión 2.0
17 de diciembre de 2012
ÍNDICE
Índice
1. Introducción
2. Aspectos generales
2
6
6
3. Tipos de documento y nomenclatura utilizada
8
9
3.1. Documentos de SMS Terminados (MT) . . . . . . . . . . . . .
. . . . . . . . . . 10
3.2. Documentos de MMS Terminados (MMST)
3.3. Documentos de SMS Originados (MO)
. . . . . . . . . . . . . 11
3.4. Documentos de MMS Originados (MMSO) . . . . . . . . . . . 11
4. Fichero DTD
5. Listado de operaciones de la API
12
13
6. Elementos utilizados en las operaciones XML
15
6.1. Elemento user . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.2. Elemento password . . . . . . . . . . . . . . . . . . . . . . . . 15
6.3. Elemento dst
. . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.4. Elemento mt id . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.5. Elemento mmst id . . . . . . . . . . . . . . . . . . . . . . . . 16
6.6. Elemento src
. . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.7. Elemento mo . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.8. Elemento mmso . . . . . . . . . . . . . . . . . . . . . . . . . . 17
7. Formato XML de la respuesta
17
7.1. Códigos de estado de la respuesta . . . . . . . . . . . . . . . . 17
8. SMS Certificado y Contrato SMS. Estado
19
8.1. Estado del proceso de firma . . . . . . . . . . . . . . . . . . . 19
8.2. Formato de la consulta signature_status . . . . . . . . . . . 19
8.3. Subelementos del elemento result . . . . . . . . . . . . . . . 19
8.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
9. SMS Certificado y Contrato SMS. Modo Base64
22
9.1. Recuperación del documento (modo base64) . . . . . . . . . . 22
9.2. Formato de la consulta get_pdf_content . . . . . . . . . . . 22
9.3. Subelementos del elemento result . . . . . . . . . . . . . . . 22
9.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
ÍNDICE
3
10.SMS Certificado y Contrato SMS. Modo Binario
26
10.1. Recuperación del documento (modo binario) . . . . . . . . . . 26
10.2. Formato de la consulta download_pdf . . . . . . . . . . . . . 27
10.3. Subelementos del elemento result . . . . . . . . . . . . . . . 27
10.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
11.MO Certificado. Estado
29
11.1. Estado del proceso de firma . . . . . . . . . . . . . . . . . . . 29
11.2. Formato de la consulta mo_signature_status . . . . . . . . . 29
11.3. Subelementos del elemento result . . . . . . . . . . . . . . . 29
11.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
12.MO Certificado. Modo Base64
32
12.1. Recuperación del documento (modo base64) . . . . . . . . . . 32
12.2. Formato de la consulta mo_get_pdf_content . . . . . . . . . 32
12.3. Subelementos del elemento result . . . . . . . . . . . . . . . 32
12.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
13.MO Certificado. Modo Binario
36
13.1. Recuperación del documento (modo binario) . . . . . . . . . . 36
13.2. Formato de la consulta mo_download_pdf . . . . . . . . . . . 37
13.3. Subelementos del elemento result . . . . . . . . . . . . . . . 37
13.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
14.MMS Certificado y Contrato MMS. Estado
39
14.1. Estado del proceso de firma . . . . . . . . . . . . . . . . . . . 39
14.2. Formato de la consulta mmst_signature_status . . . . . . . 39
14.3. Subelementos del elemento result . . . . . . . . . . . . . . . 39
14.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
15.MMS Certificado y Contrato MMS. Modo Base64
43
15.1. Recuperación del documento (modo base64) . . . . . . . . . . 43
15.2. Formato de la consulta mmst_get_pdf_content . . . . . . . . 43
15.3. Subelementos del elemento result . . . . . . . . . . . . . . . 43
15.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
16.MMS Certificado y Contrato MMS. Modo Binario
47
16.1. Recuperación del documento (modo binario) . . . . . . . . . . 47
16.2. Formato de la consulta mmst_download_pdf . . . . . . . . . . 48
16.3. Subelementos del elemento result . . . . . . . . . . . . . . . 48
16.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
ÍNDICE
4
17.MMSO Certificado. Estado
50
17.1. Estado del proceso de firma . . . . . . . . . . . . . . . . . . . 50
17.2. Formato de la consulta mmso_signature_status . . . . . . . 50
17.3. Subelementos del elemento result . . . . . . . . . . . . . . . 50
17.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
18.MMSO Certificado. Modo Base64
53
18.1. Recuperación del documento (modo base64) . . . . . . . . . . 53
18.2. Formato de la consulta mmso_get_pdf_content . . . . . . . . 53
18.3. Subelementos del elemento result . . . . . . . . . . . . . . . 53
18.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
19.MMSO Certificado. Modo Binario
57
19.1. Recuperación del documento (modo binario) . . . . . . . . . . 57
19.2. Formato de la consulta mmso_download_pdf . . . . . . . . . . 58
19.3. Subelementos del elemento result . . . . . . . . . . . . . . . 58
19.4. Ejemplos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
20.Página html de test
21.Certificación de mensajes recibidos (MO o MMSO)
60
61
22.Notas adicionales y restricciones de uso
61
22.1. Disponibilidad de los datos . . . . . . . . . . . . . . . . . . . . 61
22.2. Ratios de consulta permitidos . . . . . . . . . . . . . . . . . . 62
Copyright
(c) 2008 - LleidaNetworks Serveis Telemátics, S.L.
Todos los derechos reservados
Este documento contiene información propietaria y confidencial. Queda total-
mente prohibido distribuir sus contenidos total o parcialmente por cualquier
medio, sea físico o electrónico, sin la autorización expresa de su titular.
1 INTRODUCCI ÓN
1.
Introducción
6
La api PDFXMLAPI permite obtener mediante consultas HTTP los doc-
umentos generados por el servicio de SMS certificado o MMS certificado de
Lleida Networks desde redes securizadas mediante firewalls que sólo permitan
el tráfico saliente de navegación web estándar.
Además, al utilizar el protocolo HTTP y el formato XML para la repre-
sentación de los datos, se asegura una rápida integración con la aplicación
del cliente, puesto que la mayoría de los lenguajes de programación disponen
de un excelente soporte para ambos.
Actualmente, la api permite descargar o recuperar copia de varios tipos
de documentos, en función del evento que da origen a su generación, ya sean
ligados al envío de un SMS (MT), al envío de un MMS (MMST), la recepción
en la modalidad certificadada a correo de un SMS (MO) o la recepción en la
modalidad certificada a correo de un MMS (MMSO).
2. Aspectos generales
Las operaciones disponibles para la consulta del estado de firma y la
obtención de los documentos certificados se invocan mediante la ejecución
del CGI situado en http://pdfxml.api.lleida.net/cgi-bin/pdfxmlapi.
cgi.
La llamada al CGI debe hacerse con el método POST del protocolo
HTTP.
La llamada al CGI debe incluir la variable xml, donde se encontrarán los
datos de la operación codificados según el formato XML que se describe en
las secciones posteriores.
La respuesta del CGI será siempre normalmente en formato XML, a ex-
cepción de un caso particular en las operaciones de tipo donwload (modo bi-
nario) disponibles para cada tipo de documento (operaciones donwload_pdf,
mo_download_pdf, mmst_download_pdf y mmso_download_pdf). En estas
operaciones, siempre que sea posible devolver el documento solicitado, el
resultado obtenido no será de tipo xml sino que se retornará directamente
el contenido binario del pdf directamente, por lo que estas operaciones son
2 ASPECTOS GENERALES
7
ideales para ser utilizadas como enlace o url directa de descarga al documento
(con un tratamiento mínimo de la respuesta obtenida).
En caso de optar por la utilización de las operaciones de recuperación
de ficheros en modo base64 (como get_pdf_content), el contenido de los
ficheros pdf se entregará al cliente dentro de la misma respuesta XML, codi-
ficando los datos binarios al formato base64. A continuación el cliente podrá
escoger entre guardar dichos datos en dicho formato directamente o bien de-
scodificarlos convenientemente para obtener el fichero pdf original (los datos
binarios).
La disponibilidad de los ficheros en el repositorio del sistema una vez fi-
nalizado el proceso de firma y generado el documento pdf correspondiente
está limitado a varios meses.
Cualquier combinación incorrecta de los elementos requeridos o bien la
consulta de los datos de un SMS (MT) o un MMS (MMST) que no haya sido
enviado con solicitud de acuse de tipo certificado devolverá siempre un resul-
tado erróneo (status -3, Consulta Invalida). Ver la sección 7.1 para intentar
evitar todas las posibles casuísticas de error.
3 TIPOS DE DOCUMENTO Y NOMENCLATURA UTILIZADA
8
3. Tipos de documento y nomenclatura uti-
lizada
Existen varios tipos de documento certificado, aquellos que se generan por
la acción inicial de enviar un mensaje en la modalidad certificada o contrato
(vinculados principalmente con un SMS o MMS terminado) o aquellos que
se generan incondicionalmente por el hecho de tener activada la certificación
de los mensajes recibidos a un número asignado (vinculados Únicamente con
un SMS o MMS originado). En esta documentación se hará referencia a los
SMS enviados(Terminated) o recibidos(Originated) con la notación MT o
MO, respectivamente. Para los MMS enviados o los MMS recibidos se usara
de forma similar la notación MMST o MMSO, respectivamente. Teniendo
en cuenta esto, puede relacionarse cada tipo de documento con su mensaje
principal o de referencia d
Comentarios de: Obtención vía HTTP de los documentos PDF generados por el servicio de SMS/MMS certificado (0)
No hay comentarios