Las API son un conjunto de comandos, funciones y protocolos informáticos que permiten a los desarrolladores crear programas específicos para ciertos sistemas operativos. Las API simplifican en gran medida el trabajo de un desarrollador / programador, ya que no tiene que crear desde cero. Estas permiten al informático usar funciones predefinidas para interactuar con el sistema operativo o con otro programa. La abreviatura viene del término en inglés Application Programming Interfaces (Interfaces de programación de aplicaciones).
Los planes Pyme 1 y Pyme 2 les permiten a nuestros clientes conectar el sistema ERP de su negocio con nuestra plataforma de facturación electrónica, a través del API Ticopay.
En este artículo, dirigido a desarrolladores, indicaremos el paso a paso de cómo se realiza la conexión del API Ticopay.
Importar la librería de Ticopay Dll desde Nuget
Para comenzar a utilizar el Dll para el consumo del Api de Ticopays , lo primero que debemos hacer es seleccionar el proyecto que utilizara la Dll en el Explorador de Soluciones.
Luego de seleccionar el Proyecto (EjemploTicoayDll en nuestro caso) , hacer clic derecho para desplegar el menú de opciones.
A continuación, seleccionamos la opción de manejador de paquetes de Nuget.
En esta pantalla hacemos clic en la pestaña de Buscar o Browse y en la casilla de búsqueda colocamos Ticopay.
Una vez ubicado la versión de TicopayDll que queremos instalar seleccionamos el botón de Instalar o Install.
Cabe destacar que las versiones V1.1.X.X Pertenecen al ambiente de Producción mientras que las versiones V1.0.X.X pertenecen al ambiente del Sandbox de Pruebas.
Visual Estudio nos preguntara si estamos de acuerdo de con la instalación de la librería, hacemos clic en Ok.
Junto con la librería de TicopayDll se instalara la Librería de Newtonsoft Json , la cual los ayuda a serializar la data a enviar al Api , y transformar el Json Recibido en objetos.
Una vez que se haya realizado correctamente la instalación podremos ver en la pestaña de Instalados o Installed las librerías instaladas.
Autentificarse utilizando Ticopay Dll
Para poder realizar cualquier operación con el Api de Ticopays mediante la librería es necesario primero que procesamos a autentificarnos usando el Sub Dominio, usuario y clave que nos fue proporcionado para utilizar Ticopays, a continuación, mostraremos un ejemplo de cómo crear un método de autentificación y como ingresar a Ticopays con el mismo.
En este ejemplo podemos ver como se realiza un llamado al Api usando la librería de TicopayDll enviándole las credenciales de seguridad, se obtiene la respuesta y usando la librería de Newtonsoft se De serializa la respuesta y se devuelve el token de seguridad que deberá ser enviado a cualquiera de los métodos del Api para poder ejecutarlos.
Este token solo dura por defecto 20 min, luego de este tiempo deberemos autentificarnos de nuevo o usar el método de refreshToken para extender su duración.
Para armar este objeto con las credenciales de seguridad podemos observar el siguiente ejemplo:
Crear un cliente usando TicopayDll
Para crear un Cliente usando el Dll debemos crear un método que construya el cliente y lo envié a Ticopays, a continuación, mostraremos un ejemplo de cómo crear un método para insertar un nuevo cliente.
El método recibe un objeto de tipo Client (Cliente) y el token de seguridad previamente solicitado durante la autentificación, enviamos este cliente a Ticopays y si la creación del mismo es exitosa, recibimos el objeto del nuevo cliente creado (Incluyendo su Id único que usaremos más adelante para otros métodos), de lo contrario recibiremos un mensaje con los problemas que surgieron al intentar crear el cliente.
Para mostrar cómo crear el objeto del cliente a enviar y como llamar a nuestro método podemos observar el siguiente ejemplo:
Consultar Clientes usando TicopayDll
Para consultar los clientes que tenemos creados hasta ahora debemos realizar un método que invoque al Dll y nos retorne la lista de clientes, a continuación, mostraremos un ejemplo consultando todos los clientes disponibles.
Este método busca en Ticopay todos los clientes creados en el sistema, pero solo retorna la información principal de los mismos (Si los datos son retornados con el detalle completo o no se controla con una bandera al momento de llamar al método), una vez obtenida la respuesta De serializamos los datos en usando el objeto apropiado y extraemos del mismo la lista de clientes que fueron encontrados.
A continuación, mostraremos un ejemplo del uso de este método:
Creación de una factura utilizando la librería de TicopayDll
Para enviar una factura a Ticopays debemos crear un método que reciba el objeto de la nueva factura y utilice el Dll para enviar la factura a Ticopays, a continuación, mostramos como crear un método para él envió de facturas.
El método recibe el objeto de la factura junto a token de seguridad, envía a Ticopays la misma y de crearse exitosamente recibe y de serializa la factura creada (La misma incluye el Id Único que será utilizado en otros métodos para referirse a la misma).
Para consumir este método mostraremos a continuación un código de ejemplo:
Blog Ticopay 