Manual de usuario API IntTfhkaFel21 - Indice Manual Integración Directa

De tfhkacolwiki
Revisión del 18:15 26 jul 2021 de Dmrodriguez (discusión | contribuciones) (Página creada con «<includeonly>=</includeonly>== '''API IntTfhkaFel21''' ==<includeonly>=</includeonly> === OBJETIVO === El presente manual tiene como propósito dar a conocer los detalles…»)
(dif) ← Revisión anterior | Revisión actual (dif) | Revisión siguiente → (dif)
Ir a la navegación Ir a la búsqueda

API IntTfhkaFel21

OBJETIVO

El presente manual tiene como propósito dar a conocer los detalles de la interfaz de aplicación IntTfhkaFel21 para la integración directa y la descripción de las funciones para la generación de facturación electrónica ofrecida por The Factory HKA Colombia SAS.

ALCANCE

El presente documento abarca desde la configuración del API hasta las funciones utilizables para el consumo del Servicio Web de Integración. La librería IntTfhkaFel21 es multiplataforma, es decir, compatible con sistemas operativos Windows y Linux.

Esta librería permite consumir el servicio de integración de The Factory HKA Colombia SAS en sistemas administrativos (ERP) que nativamente tienen limitantes para el consumo de servicios web referenciando o importando el WSDL.


DEFINICIONES Y TÉRMINOS

EXE: En el ámbito de la informática .exe (de la abreviación del inglés executable, que se traduce en ejecutable) es una extensión que se refiere a un archivo ejecutable de código reubicable, es decir, sus direcciones de memoria son relativas. Los sistemas operativos que utilizan de forma nativa este formato son DOS, Microsoft Windows, OS/2 y ReactOS.

Servicio Web de Integración: Servicio Web de The Factory HKA Colombia SAS puesto en disposición a propietarios de software administrativos o de gestión para la generación de factura electrónica.

CONFIGURACÍON

En el archivo descargado, se encontrará con las tres herramientas básicas para realizar la integración del software administrativo con nuestra plataforma de factura electrónica: librería de integración indirecta (IntTfhkaFel21), el presente manual y un archivo de texto (config.txt) que contendrá los datos de acceso a la plataforma de facturación electrónica de The Factory HKA. La estructura del archivo config.txt debe ser la siguiente:

Configuración Config_ne.xml
ConfiguracionApi

Donde:

  • 1: Corresponde a la URL para consumir el servicio de Emisión.
  • 2: Corresponde a la URL para consumir el servicio de Adjuntos.
  • 3: Corresponde a la URL para consumir el servicio de Reportes.
  • 4: Corresponde al token empresa (suministrado por TFHKA).
  • 5: Corresponde al token password (suministrado por TFHKA).
  • 6: Personalización de ruta y nombre del archivo Resultado.txt (OPCIONAL)

Luego de editar el archivo config.txt de acuerdo a lo descrito anteriormente, la librería estará lista para ser utilizada desde la ventana de comandos del sistema (CMD ó BASH).

FUNCIONES DE LA LIBRERÍA

Versión:

Para saber la versión del API IntfhkaFel21, puede ejecutar el siguiente comando desde la consola del sistema:

  • IntTfhkaFel.exe version (Windows)
  • ./IntTfhkaFel version (Linux)

En el presenta manual se describen las funcionalidades disponibles del API IntfhkaFel21 que pone a disposición del desarrollador las funciones del Servicio Web de Integración de The Factory HKA Colombia SAS, dichas funciones se listan a continuación: