Instalación

Primeramente, hay que comprender la estructura o funcionamiento del API, ya que esta funciona como una sólida base que nos permite extender y crear sobre ella por medio de módulos.

En este caso, el API cuenta con los módulos para realizar las diferentes tareas necesarias para la conexión con el Ministerio de Hacienda, asimismo como lo necesario para formatear la información y realizar las solicitudes necesarias. Lo único que es necesario, es tener la información de cada documento para realizar los diferentes procedimientos.

Es necesario identificar las 2 carpetas que estaremos utilizando. La primera es ‘www’, esta carpeta debe estar en una sección pública de su servidor y es nuestra puerta de entrada a los diferentes módulos.

Dentro de esta carpeta se encuentra un documento en Php que se llama api.php. A este documento es al que se le deben hacer las diferentes solicitudes, ya sean POST, GET o por terminal.

Adicional se encuentra otro documento ‘settings.php’, en este se debe ingresar la configuración de la conexión a la base de datos y la ubicación de en donde se encuentra la segunda carpeta contigua a ‘www’, la cual tiene como nombre ‘api’.

¿Por qué está separado en 2 secciones?

La idea de esto es que el ‘www’ esté en una sección pública, y el resto del API con nuestros módulos, se encuentre en una sección en donde no sea abierto o accesible de manera pública. Esto nos brinda seguridad adicional en caso de que haya intromisión dentro del servidor y los documentos del API se encuentren resguardados por la seguridad del servidor o bien, de su sistema operativo.

Nosotros recomendamos utilizar un sistema Linux o basado en Unix ya que en entornos de servidores web son más ligeros, pero de igual manera se ha probado en IIS y el funcionamiento es óptimo.

Una vez que agreguemos los valores correctos en el ‘settings.php’, y tengamos nuestras carpetas en los lugares que queremos, podemos proceder a probar el API.

Para la configuración del parámetro

$config['crypto']['key'] = "{cryptoKey}";

se debe realizar un llamado a la siguiente dirección: http://api-demo.crlibre.org/api.php?w=crypto&r=makeKey y sustituir {cryptoKey} por el resultado de ese llamado.

Un ejemplo de cómo se podría ver bajo un sistema Linux, sería algo como.

Ubicación del ‘www’:

/var/www/html/api.php

Ubicación del ‘api’

/var/www/api

De esta manera la ubicación del api en el settings.php línea 38, se definiría como:

$config['modules']['coreInstall'] = "../api/";