Diferencia entre revisiones de «API CearCliente»
(Página creada con «La API '''CrearCliente''' es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de crear todo el catalogo de clientes a…») |
|||
(No se muestran 2 ediciones intermedias de 2 usuarios) | |||
Línea 25: | Línea 25: | ||
|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 | ||
|- | |- | ||
− | | | + | |TokenClave |
|- | |- | ||
|String | |String | ||
|ClaveSecreta | |ClaveSecreta | ||
− | |Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción | + | |Definida por el contribuyente emisor a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción |
|- | |- | ||
|Array <Clientes> | |Array <Clientes> | ||
Línea 36: | Línea 36: | ||
|} | |} | ||
<br> | <br> | ||
+ | |||
+ | <br> | ||
+ | ; RESPONSE: Parámetros a Recibir al consultar el Método CrearCliente | ||
+ | {| 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 del contribuyente asignado por The Factory HKA Colombia (Uso Interno) | ||
+ | |- | ||
+ | |String | ||
+ | |IdCliente | ||
+ | |Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) | ||
+ | |- | ||
+ | |} | ||
+ | {{clear}} | ||
+ | <br> | ||
+ | |||
+ | <center>'''Ejemplo Response CrearCliente '''</center> | ||
+ | [[Archivo:CrearCliente.png|800px|sinmarco|centro|CrearCliente]] | ||
+ | <br /> | ||
+ | <br /> |
Revisión actual del 03:33 13 jul 2024
La API CrearCliente es un desarrollo elaborado por el equipo de The Factory HKA el cual brinda la posibilidad al contribuyente de crear todo el catalogo de clientes a los cuales debe realizarles algún documento electrónico, y posteriormente los podrá visualizar en el portal de HKA Factura en ambiente demo y en ambiente de producción o a realizar el consumo del servicio a través de la Api ConsultarCliente.
@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:
CrearCliente
A continuación se documenta la estructura que se debe contemplar en la construcción del Request y el Response del servicio CrearClientey 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 a través del portal HKA Factura Electrónica en ambiente demo y en ambiente de producción |
Array <Clientes> | Cliente | Parámetros que conforman la clase Cliente del Objeto Factura' |
- RESPONSE
- Parámetros a Recibir al consultar el Método CrearCliente
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:
|
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 del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |
String | IdCliente | Identificador del contribuyente asignado por The Factory HKA Colombia (Uso Interno) |