Diferencia entre revisiones de «API EnviarCorreo»
| Línea 28: | Línea 28: | ||
|String | |String | ||
|ClaveSecreta | |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 | + | |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> | |Array <DatosEnvio> | ||
| Línea 49: | Línea 49: | ||
|Corresponde al correo electrónico a el cual se va a enviar el reporte. | |Corresponde al correo electrónico a el cual se va a enviar el reporte. | ||
|} | |} | ||
| + | <br> | ||
| + | <br> | ||
| + | |||
| + | <center>'''Ejemplo Request EnviarReporte'''</center> | ||
| + | [[Archivo:RequestEnviarReporte.png|800px|sinmarco|centro|Request Enviar Reporte]] | ||
| + | <br /> | ||
| + | <br /> | ||
| + | |||
| + | ; RESPONSE: Parámetros a Recibir al consumir la Api DescargarReporte | ||
| + | {| class="mw-collapsible wikitable" | ||
| + | ! style="background:#f2f2f2; text-align:center;"|Tipo | ||
| + | ! style="background:#f2f2f2; text-align:center;"|Identificador | ||
| + | ! style="background:#f2f2f2; text-align:center;"|Descripción | ||
| + | |- valign="center" | ||
| + | |- | ||
| + | |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. | ||
| + | |} | ||
| + | {{clear}} | ||
| + | <br> | ||
| + | <br> | ||
| + | |||
| + | |||
| + | <center>'''Ejemplo Response EnviarReporte'''</center> | ||
| + | [[Archivo:ResponseEnviarReporte.png|800px|sinmarco|centro|Response Enviar Reporte]] | ||
| + | <br /> | ||
| + | <br /> | ||
| + | <br> | ||
<br> | <br> | ||
Revisión del 20:58 29 abr 2024
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 |
| TokenPassword | ||
| 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. |
- 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:
|
| 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. |
