Diferencia entre revisiones de «API ConsultarCertificado»

De tfhkacolwiki
Ir a la navegación Ir a la búsqueda
 
(No se muestran 2 ediciones intermedias de 2 usuarios)
Línea 24: Línea 24:
 
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
 
|rowspan="2"|Suministrado por The Factory HKA Colombia según el ambiente a consultar
 
|-
 
|-
−
|TokenPassword
+
|TokenClave
 
|}
 
|}
 
<br>
 
<br>
 +
<br>
 +
; RESPONSE: Parámetros a Recibir al consultar el Método ConsultarCertificado
 +
{| 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
 +
|Resultado
 +
|Resultado del consumo del método:
 +
: “Exitoso” ó “Error”
 +
|-
 +
|String
 +
|Mensaje
 +
|Este mensaje está asociado al codigo, útil para identificación de errores
 +
|-
 +
|String
 +
|Nit
 +
|Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
 +
|-
 +
|String
 +
|idEmpresa
 +
|Identificador interno del Contribuyente emisor ante TFHKA
 +
|-
 +
|String
 +
|Certificado
 +
|Ver Response Array certificado a continuación
 +
|-
 +
|}
 +
 +
 +
 +
; RESPONSE: Parámetros a Recibir Array Certificado
 +
{| 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
 +
|Serie
 +
|Identificador del secuencial configurado en los portales de TFHKA
 +
|-
 +
|dateTime
 +
|ValidoDesde
 +
|Inicio de activación
 +
|-
 +
|dateTime
 +
|ValidoHasta
 +
|Fin de activación
 +
|-
 +
|String
 +
|RazonSocial
 +
|Razón social de la empresa
 +
|-
 +
|String
 +
|Proveedor
 +
|Información correspondiente al proveedor
 +
|-
 +
|}
 +
{{clear}}
 +
<br>
 +
 +
<center>'''Ejemplo  Response Consultar Certificado'''</center>
 +
[[Archivo:consultarCertificado.png|800px|sinmarco|centro|consultarCertificado]]
 +
<br />

Revisión actual del 03:34 13 jul 2024

La API ConsultarCertificado es un desarrollo elaborado por el equipo de The Factory HKA el cual tiene como objetivo que cada contribuyente pueda conocer el estado en el cual se encuentra su certificado digital asignado al adquirir el servicio con The Factory HKA Colombia en el ambiente demo y en ambiente de producción.

@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 visitar la siguiente sección: 

ConsultarCertificado

A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio ConsultarCertificado 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 a consultar
String TokenEmpresa Suministrado por The Factory HKA Colombia según el ambiente a consultar
TokenClave



RESPONSE
Parámetros a Recibir al consultar el Método ConsultarCertificado
Tipo Identificador Descripción
int Código Indica el estado de la operación retornado por el servicio
String Resultado Resultado del consumo del método:
“Exitoso” ó “Error”
String Mensaje Este mensaje está asociado al codigo, útil para identificación de errores
String Nit Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno)
String idEmpresa Identificador interno del Contribuyente emisor ante TFHKA
String Certificado Ver Response Array certificado a continuación


RESPONSE
Parámetros a Recibir Array Certificado
Tipo Identificador Descripción
int Serie Identificador del secuencial configurado en los portales de TFHKA
dateTime ValidoDesde Inicio de activación
dateTime ValidoHasta Fin de activación
String RazonSocial Razón social de la empresa
String Proveedor Información correspondiente al proveedor


Ejemplo Response Consultar Certificado
consultarCertificado


Obtenido de «http://felcowiki.thefactoryhka.com.co/index.php?title=API_ConsultarCertificado&oldid=5958»