API EnviarCorreo

De tfhkacolwiki
Revisión del 03:43 13 jul 2024 de Dmrodriguez2 (discusión | contribuciones)
(dif) ← Revisión anterior | Revisión actual (dif) | Revisión siguiente → (dif)
Ir a la navegación Ir a la búsqueda

La API EnviarCorreo es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de poder compartir por correo electrónico los Reportes Programado o agendados previamente se puede utilizar en el ambiente demo y en ambiente de producción o al realizar el consumo del servicio a través de la Api EnviarCorreo.

@IMPORTANTE: Para el consumo de este servicio se han establecido dos url especificas en ambiente DEMO y ambiente PRODUCCION las cuales las podrá encontrar a continuación:

Para mayor información pude consultas las URL en la siguiente sección:

EnviarCorreo

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio EnviarCorreo y de esta forma garantizar la implementación de este nuevo método:

REQUEST
Parámetros a Enviar
Tipo Identificador Descripción
String Nit Número de documento del contribuyente emisor.
String TokenEmpresa Suministrado por The Factory HKA Colombia según el ambiente a consultar
TokenClave
String ClaveSecreta Definida por el contribuyente emisor desde el usuario root a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción.
Array <DatosEnvio> DatosEnvio Parámetros que conforman el Array DatosEnvio

Donde Class.DatosEnvio contiene la siguiente información:

Tipo Identificador Descripción
String IdReporte Código con el que se identifica el reporte a descargar.
String Correo Corresponde al correo electrónico a el cual se va a enviar el reporte.



Ejemplo Request EnviarReporte
Request Enviar Reporte



RESPONSE
Parámetros a Recibir al consumir la Api DescargarReporte
Tipo Identificador Descripción
int Código Indica el estado de la operación retornado por el servicio
String Mensaje El Reporte ha sido enviado por correo satisfactoriamente
String Resultado Resultado del consumo del método:
“Procesado” ó “Error”
String IdReporte Codigo identificador del Reporte agendado enviado por correo.
String GeneradoEstadoLegal Codigo indica si el reporte generado se envio por correo con estadoLegal
String Errores Indica la descripcion de los posibles errores al momento de descargar el reporte agendado.




Ejemplo Response EnviarReporte
Response Enviar Reporte