Servicios Web para Centros de Impresión y Ensobrado

Transcripción

1 Servicio compartido de Gestión de Notificaciones Servicios Web para Centros de Impresión y Ensobrado ATENCIÓN: Para la comprensión de este documento, debe consultarse el Glosario de Términos y Especificaciones Notific@ que dispone de todos los términos y abreviaturas utilizados, así como su definición y en algunos casos, las especificaciones técnicofuncionales asociadas a los mismos. Manual Versión 1.3 Fecha de revisión: 17/05/2017 Realizado por 1

2 Contenido 1. Control de versiones Objetivo del Documento Descripción de los Entornos Acceso al Entorno de Producción Consideraciones adicionales...4 ANEXO I Documentación de las operaciones de los Servicios Web...4 ANEXO II Explicación de los campos del Servicio Web EnvioCentroImpresión a implementar por los CIEs...5 ANEXO III Explicación de los campos de los Servicios Web ofrecidos por Notific@ para la recepción de datados y certificados...8 ANEXO IV PLAN DE PRUEBAS DE NOTIFIC@ HACIA EL CIE...9 ANEXO V ESTADOS DE UN ENVÍO

3 1. Control de versiones Versión Fecha Comentario 1.0 Versión inicial 1.1 Añadido Anexo V /01/2016 Añadida opción soloverificar Establecidas longitudes máximas de campos tipo string Sustitución de la lista de estados del Anexo IV por referencia al documento sobre datados y certificaciones del CTT /02/2016 Se añade el capítulo /05/2017 Mayor detalle en especificación del NCC. Cambios marcados en amarillo 2. Objetivo del Documento En este documento se describe el Servicio Web que deben implementar los Centros de Impresión y Ensobrado (CIE) para que Notific@ pueda realizar sus envíos. También describe los Servicios Web que Notific@ pone a disposición de los CIEs para el envío del Datado y la Certificación de las notificaciones. 3. Descripción de los Entornos El CIE debe disponer de dos entornos (pruebas y producción) para poder realizar las pruebas pertinentes en relación al envío de notificaciones mediante el método altaenvio dentro del Servicio Web EnvioCentroImpresión. Del mismo modo, para la recepción de Datados y la Certificaciones, Notific@ pone a disposición los siguientes entornos: - Entorno de Pruebas-Preproducción. o Dirección de EndPoint para el Datado: o Dirección de EndPoint para la Certificación: - Entorno de Producción : o Dirección de Endpoint para los WS de Datado: 3

4 o Dirección de Endpoint para los WS de Certificación: Será necesario el intercambio de las partes públicas de los certificados entre el CIE y Notific@ para el acceso a los servicios web de forma segura. 4. Acceso al Entorno de Producción Una vez estén finalizadas las cuestiones relacionadas con las pruebas de manera satisfactoria, y en función de las cuestiones legales previas a ser contempladas y concretadas, se procederá de manera análoga a las pruebas en el entorno de preproducción. 5. Consideraciones adicionales A mayores del contenido de este documento, deben tenerse en cuenta las consideraciones técnicas que se detallan en el manual de servicios web para organismos y sedes. En particular se recomienda revisar: El capítulo 3 de Condiciones especiales en el procedimiento de integración con Notific@ a través de los Servicios Web. Las direcciones IP en las cuales Notific@ publica sus Web Services para CIEs en Red SARA son las mismas que las correspondientes a los Web Services para Organismos Emisores y que se muestran en el capítulo 5.1. Si el CIE se encuentra fuera de la Red Sara se le contestará a través de la incidencia los datos técnicos para conectarse con Notific@. Las direcciones IP que utiliza Notific@ para comunicarse con los servicios que exponen los CIEs son las mismas que para comunicarse con los Advisers dentro de Red SARA. En general, de cara a la interpretación del manual de servicios web para organismos y sedes, las consideraciones realizadas sobre el servicio Adviser, en cuanto a servicio expuesto por alguien ajeno al que se conecta Notific@, son asimilables a los servicios Web que publica el CIE y, por su lado, los servicios expuestos por Notific@ para Organismos equiparables a los servicios de datadows o certificaciónws. ANEXO I Documentación de las operaciones de los Servicios Web Puede encontrar una definición detallada de las operaciones y los elementos del Servicio Web de Notific@ para la integración con los organismos en las siguientes direcciones: Servicio Web EnvioCentroImpresión a implementar por los CIEs: Servicios Web ofrecidos por Notific@ para la recepción de datados y certificados. 4

5 ANEXO II Explicación de los campos del Servicio Web EnvioCentroImpresión a implementar por los CIEs altaenvio organismo_emisor::codigo_dir3: campo obligatorio correspondiente al código DIR3 del Organismo Emisor. organismo_emisor::nombre: campo opcional para indicar el nombre de la Entidad Emisora. Notific@ lo rellena conforme al literal DIR3 oficial. organismo_pagador_cie::codigo_dir3: campo obligatorio correspondiente con el código DIR3 del organismo que realizará el pago de la notificación. organimso_pagador_cie::fecha_limite_autorizacion: fecha de expiración de la relación establecida entre el organismo emisor y el CIE. organismo_pagador_correos::numero_contrato_correos: Número de contrato del organismo pagador con Correos organismo_pagador_correos::codigo_cliente_facturacion_correos: Código cliente del organismo pagador para la facturación con correos referencia_origen: Referencia del envío establecida por el Organismo Emisor al darlo de alta. Campo obligatorio. Máximo 20 caracteres. tipo_envio: El tipo de envío puede ser 'notificacion' o 'comunicación' concepto: El concepto del envío que se realiza. Campo obligatorio. Máximo 50 caracteres. titular: Datos personales del Titular de la notificación. Está compuesto por los campos NIF y Nombre (con los apellidos, si corresponde, concatenados) con longitud máxima de 125. destinatario: Datos personales del Destinatario de la notificación. Está compuesto por los campos NIF y Nombre (con los apellidos, si corresponde, concatenados) con longitud máxima de 125. Aunque sean los mismos datos que el Titular también deben completarse. vinculo_titular_destinatario: Valores válidos: titular o representante, dependiendo si el destinatario es el mismo que el titular o sin distintos. 5

6 tipo_domicilio: debe contener el valor concreto domicilio_concreto: Dependiendo del tipo cambian los campos obligatorios dentro de 'domicilio_concreto': Nacional: tipo_via: Se corresponde con los siguientes tipos: 'ALMDA' => 'ALAMEDA', 'CALLE' => 'CALLE', 'CAMNO' => 'CAMINO', 'CARR' => 'CARRER', 'CTRA' => 'CARRETERA', 'GTA' => 'GLORIETA', 'KALEA' => 'KALEA', 'PSJ' => 'PASAJE', 'PASEO' => 'PASEO', 'PLAÇA' => 'PLAÇA', 'PLAZA' => 'PLAZA', 'RAMBL' => 'RAMBLA', 'RONDA' => 'RONDA', 'RÚA' => 'RÚA', 'SECT' => 'SECTOR', 'TRAV' => 'TRAVESÍA', 'URB' => 'URBANIZACIÓN', 'AVDA' => 'AVENIDA', 'AVGDA' => 'AVINGUDA', 'BAR' => 'BARRIO', 'CJA' => 'CALLEJA', 'CAMÍ' => 'CAMÍ', 'CAMPO' => 'CAMPO', 'CRA' => 'CARRERA', 'CSTA' => 'CUESTA', 'EDIF' => 'EDIFICIO', 'EPTZA' => 'ENPARANTZA', 'ESTR' => 'ESTRADA', 'JARD' => 'JARDINES', 'JARDI' => 'JARDINS', 'PRQUE' => 'PARQUE', 'PSG' => 'PASSEIG', 'PRAZA' => 'PRAZA', 'PLZA' => 'PLAZUELA', 'PLCTA' => 'PLACETA', 'POBL' => 'POBLADO', 6

7 'VIA' => 'VIA', 'TRAVS' => 'TRAVESSERA', 'PASTG' => 'PASSATGE', 'BVR' => 'BULEVAR', 'POLIG' => 'POLÍGONO', 'OTROS' => 'OTROS', nombre_via: Máximo 50 caracteres. Tipo_numeracion: Con los siguientes valores posibles: 'num', 'pkm', 's/n', 'apc' numero_casa o punto_kilometrico (solo uno de los dos). Máximo 5 caracteres poblacion: Máximo 30 caracteres municipio::codigo_ine y literal de máximo 30 caracteres. codigo_postal. Máximo 10 caracteres, aunque en España se usan 5. provincia::codigo_provincia (código INE) y literal de máximo 30 caracteres. pais::codigo_iso3166 y literal de máximo 30 caracteres. Extranjero: nombre_via: Máximo 50 caracteres pais::codigo_iso3166 y literal de máximo 30 caracteres. codigo_postal: Máximo 10 caracteres población Máximo 30 caracteres Apartado de Correos: apartado_correos: Máximo 10 caracteres provincia::codigo_provincia y literal de máximo 30 caracteres. municipio::codigo_ine y literal de máximo 30 caracteres. codigo_postal. Máximo 10 caracteres población. Máximo 30 caracteres domicilio_concreto_no_normalizado: deben rellenarse los campos linea1 y linea2 con las dos líneas con la información de la dirección postal (máximo 50 caracteres cada línea). Además debe indicarse el código postal (hasta 10 caracteres) y el código ISO3166 del país con su literal de máximo 30 caracteres. modo_emisión: para los envíos de Notific@ debe completarse con correos_cie pdf_base64: contenido del documento de la notificación codificado en base64 hash_sha1: codificación base64 del sha1 del contenido binario del documento opciones: Define qué aspecto de la configuración se desea establecer. Los posibles valores son: normalizado (ver glosario de términos). urgente (ver glosario de términos). 7

8 solovalidar El CIE debe hacer, en caliente, todas las comprobaciones de que el documento PDF enviado es válido y cumple con la norma CIE (PDF/A, tamaño A4, etc.) pero sin llegar a imprimirlo o a realizar ningún cargo al cliente. opciones::opcion: Adopta el valor si o no ANEXO III Explicación de los campos de los Servicios Web ofrecidos por Notific@ para la recepción de datados y certificados datado: organismo_emisor::codigo_dir3: campo obligatorio correspondiente al código DIR3 del Organismo Emisor. organismo_emisor::nombre: campo opcional para indicar el nombre de la Entidad Emisora, conforme al literal DIR3 oficial. referencia_origen: Referencia del envío establecida por el Organismo Emisor al darlo de alta. Campo obligatorio ncc: Número de Certificación/Comunicación que se asigna a cada envío en Postal. Campo obligatorio. El formato del mismo será: AA-M-N/C D, donde: - AA son las dos últimas posiciones del ejercicio - M es el canal de salida de la carta - N/C sería 0 para notificaciones y 1 para comunicaciones sería un número único y pseudoaleatorio - D es el dígito de control numero_intentos: número de intentos de notificación de los que va a adjuntarse a continuación, máximo 3. intenton::resultado_intento: resultado del intento N de envío que devuelve Correos, los valores pueden ser: ausente, notificada, rehusada, fallecido, desconocido, extraviada, direccion_incorrecta intenton::fecha_intento: fecha en la que se realiza el intento de envío, en formato AAAA-MM-DDTHH:MM:SS 8

9 resultado_final: resultado del intento más tardío fecha_notificacion: fecha en la que se realiza la notificación más tardía modo_notificacion: para Centro de Impresión y Ensobrado debe completarse con correos_cie receptor::nif: NIF del receptor del último resultado receptor::nombre: Nombre del receptor del último resultado acuse_escaneado Método para el envío del acuse de recibo escaneado organismo_emisor::codigo_dir3: campo obligatorio correspondiente al código DIR3 del Organismo Emisor. organismo_emisor::nombre: campo opcional para indicar el nombre de la Entidad Emisora, conforme al literal DIR3 oficial. referencia_origen: Referencia del envío establecida por el Organismo Emisor al darlo de alta. Campo obligatorio ncc: Número de Certificación/Comunicación que se asigna a cada envío en Postal. Campo obligatorio. certificacion::tipo_certificacion: tipo de certificación que se va a recibir, puede ser acuse_escaneado o certificacion_xml. certificacion::acuse_escaneado::acuse_o_sobre: informa si el escaneado es de un acuse de recibo o de un sobre. Los valores permitidos son acuse o sobre (ver glosario de términos) certificacion::acuse_escaneado::hash_sha1: base64 del SHA-1 del PDF binario de la certificación. certificacion::acuse_escaneado::pdf_base64: base64 del PDF con el escaneado de la certificación certificacion::certificacion_xml: XML con el contenido de la certificación ANEXO IV PLAN DE PRUEBAS DE NOTIFIC@ HACIA EL CIE Para comprobar el correcto funcionamiento del WS, una vez implementado el WS de EnvioCentroImpresion deben realizarse las siguientes pruebas de envío de notificaciones desde Notific@ hacia el CIE 9

10 Núm. Descripción de la prueba Resultado Código Resultado 1 Petición mal formada ERROR Organismo emisor que no está dado de alta en la tabla de organismos emisores autorizados del CIE ERROR Petición sin referencia origen ERROR Petición con tipo de envío distinto a notificación o electrónico ERROR Petición sin concepto ERROR Petición cuyo titular no está en el Censo del CIE (ej. NIF incorrecto) Petición cuyo destinatario no está en el Censo del CIE (ej. NIF incorrecto) Petición cuyo vínculo no sea ni titular ni representante" Petición cuyo vínculo sea titular y con titular y destinatario distintos Petición cuyo vínculo sea representante y con titular y destinatario iguales Petición cuyo tipo de domicilio no es "concreto" ni "fiscal" Petición de tipo de domicilio "concreto" del tipo Apartado de correos pero faltando algún campo obligatorio Petición de tipo de domicilio "concreto" del tipo Apartado de correos pero con Código de Municipio inexistente Petición de tipo de domicilio "concreto" del tipo domicilio nacional pero faltando algún campo obligatorio ERROR 006 ERROR 007 ERROR 008 ERROR 008 ERROR 008 ERROR 009 ERROR 010 ERROR 010 ERROR

11 Petición de tipo de domicilio "concreto" del tipo domicilio nacional pero con un código de provincia inexistente Petición de tipo de domicilio "concreto" del tipo domicilio internacional pero faltando algún campo obligatorio Petición de tipo de domicilio "concreto" del tipo domicilio nacional pero con un código de país inexistente Petición de tipo de domicilio "fiscal" pero sin poder obtener los datos del Censo del CIE ERROR 010 ERROR 010 ERROR 010 ERROR Petición cuyo modo de emisión no es "correos_cie" ERROR Petición con un PDF de un tamaño superior a 10MB ERROR Petición con un PDF que no cumple los requisitos de impresión del CIE Petición correcta con estos datos: Tipo: "notificación". Modo de emisión: "correos_cie". Domicilio: "nacional" Verificar que se inserta en la tabla y los datos son correctos Se inserta el PDF y los datos son correctos Se asigna un NCC del tipo "AA90NNNNNNNND" El número de situación es 1 El idioma es castellano El código y zona de correos son acordes al domicilio No se ha asignado código UPU Se ha asignado un CSV La fecha y el usuario de alta son correctos ERROR 013 OK

12 23 25 La fecha y el usuario de última modificación son correctos Petición correcta con estos datos: Tipo: "notificación". Modo de emisión: "correos_cie". Domicilio: "internacional" Verificar que se inserta en la tabla y los datos son correctos Se inserta el PDF y los datos son correctos Se asigna un NCC del tipo "AA90NNNNNNNND" El número de situación es 1 El idioma es castellano El código y zona de correos son acordes al domicilio Se asigna un UPU del tipo "RR90NNNNNNDES" Se ha asignado un CSV La fecha y el usuario de alta son correctos La fecha y el usuario de última modificación son correctos Petición correcta con estos datos: Tipo: "comunicación". Modo de emisión: "correos_cie". Domicilio: "internacional" Verificar que se inserta en la tabla y los datos son correctos Se inserta el PDF y los datos son correctos Se asigna un NCC del tipo "AA91NNNNNNNND" El número de situación es 1 El idioma es castellano El código y zona de correos son acordes al domicilio OK 000 OK

13 No se ha asignado código UPU Se ha asignado un CSV La fecha y el usuario de alta son correctos La fecha y el usuario de última modificación son correctos 13

14 ANEXO V ESTADOS DE UN ENVÍO Los estados por los que puede pasar un envío pueden consultarse en el CTT ( en el documento Validez de notificaciones por distintos medios - Datados y Certificaciones disponible en la carpeta Organimo Emisor Dudas Comunes. 14