@red-unica/libreria-conexiones-api

Implementación de cliente para el consumo de APIs para todo Red Única.

Intalación

$ npm install @red-unica/libreria-conexiones-api

Uso

Cómo armar la peticion

const ConexionesApi = require('@red-unica/libreria-conexiones-api');
const url = "https://dev-api.bancoazteca.com.mx:8080/identidad-digital/cliente-unico/clientes/indicadores/v1/busquedas";
const requestObject = {
    data: {"idPais": 1, "idCanal": 24, "idSucursal": 9495, "folio": 1549}, // OPCIONAL, corresponde al Body de la petición
    params: {"idPais": 1, "idCanal": 24, "idSucursal": 9495, "folio": 1549}, // OPCIONAL, corresponde a parametros del query String ej. idPais=1&idCanal=24&idSucursal=9495&folio=1549
    timeout: 2000 //OPCIONAL, Indica el tiempo de espera en milisegundos para la peticion, si la peticion tarda más tiempo que el especificado será cancelada
};
const headers = [['nombre-cabecero-1', 'valor-1'],['nombre-cabecero-2', 'valor-2']];
ConexionesApi.post(url, requestObject, headers);
ConexionesApi.put(url, requestObject, headers);
ConexionesApi.delete(url, requestObject, headers);
ConexionesApi.get(url, requestObject, headers);
ConexionesApi.patch(url, requestObject, headers);

Cómo realizar la peticion

// Opcion 1:
ConexionesApi.post(url, requestObject, headers).then(respuesta=>{
    //Manipular la respuesta exitosa
}).catch(error=>{
    //Manipular el error
});

//Opcion 2:
try{
    const respuesta = await ConexionesApi.post(url, requestObject, headers);
    //Manipular la respuesta exitosa
}catch(error){
    //Manipular el error
}

Para mayor información sobre el parametro requestObject visitar la documentación de Axios

Variables de entorno

En caso de usar la libreria en una micro-frontend React

Variables comunes:

|Variable|Descripción|Ejemplo|Valor por default| |---|---|---|---| |REACT_APP_URL_TOKEN|Porcion de la URL para la generación del Access Token|/oauth2/v1/token|| |REACT_APP_JUEZ_FRASE_SECRETA|Frase secreta usada por la libreria @red-unica/libreria-cifrado para desencriptar las credenciales|Fr4zeR3dUn1c4C3kr3t4||

Variables para consumo de APIS externas DMZ (version móvil):

|Variable|Descripción|Ejemplo|Valor por default| |---|---|---|---| |REACT_APP_CONSUMER_KEY_EXT|Consumer Key proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|to9SDSAc8VTG9aiXGPBYzX/gxc/H+uGn14Kq1b9nV/oaTxEoihwj/Ak5LYk7rmhU|| |REACT_APP_CONSUMER_SECRET_EXT|Consumer Secret proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|qQHubya9xfpRlrZBCQkbUfOfZe1rrL2wO4XHAdDSduw||| |REACT_APP_BASE_URL_EXT|URL Base para consultar el Token en de forma externa|https://api.bancoazteca.com.mx|||

Variables para consumo de APIS internas (version PC):

|Variable|Descripción|Ejemplo|Valor por default| |---|---|---|---| |REACT_APP_CONSUMER_KEY_INT|Consumer Key proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|to9SDSAc8VTG9aiXGPBYzX/gxc/H+uGn14Kq1b9nV/oaTxEoihwj/Ak5LYk7rmhU|| |REACT_APP_CONSUMER_SECRET_INT|Consumer Secret proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|qQHubya9xfpRlrZBCQkbUfOfZe1rrL2wO4XHAdDSduw||| |REACT_APP_BASE_URL_INT|URL Base para consultar el Token en de forma externa|https://prod-api.bancoazteca.com.mx|||

Asegurarse que las variables de ambiente esten definidas dentro del frontend-contenedor-principal

En caso de usar la libreria en una aplicación Express

Variables comunes:

|Variable|Descripción|Ejemplo|Valor por default| |---|---|---|---| |EXPRESS_APP_URL_TOKEN|Porcion de la URL para la generación del Access Token|/oauth2/v1/token|| |EXPRESS_APP_JUEZ_FRASE_SECRETA|Frase secreta usada por la libreria @red-unica/libreria-cifrado para desencriptar las credenciales|Fr4zeR3dUn1c4C3kr3t4||

Variables para consumo de APIS externas:

|Variable|Descripción|Ejemplo|Valor por default| |---|---|---|---| |EXPRESS_APP_CONSUMER_KEY_EXT|Consumer Key proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|to9SDSAc8VTG9aiXGPBYzX/gxc/H+uGn14Kq1b9nV/oaTxEoihwj/Ak5LYk7rmhU|| |EXPRESS_APP_CONSUMER_SECRET_EXT|Consumer Secret proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|qQHubya9xfpRlrZBCQkbUfOfZe1rrL2wO4XHAdDSduw||| |EXPRESS_APP_BASE_URL_EXT|URL Base para consultar el Token en de forma externa|https://api.bancoazteca.com.mx|||

Variables para consumo de APIS internas:

|Variable|Descripción|Ejemplo|Valor por default| |---|---|---|---| |EXPRESS_APP_CONSUMER_KEY_INT|Consumer Key proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|to9SDSAc8VTG9aiXGPBYzX/gxc/H+uGn14Kq1b9nV/oaTxEoihwj/Ak5LYk7rmhU|| |EXPRESS_APP_CONSUMER_SECRET_INT|Consumer Secret proporcionado por Gobierno de Apis. Tiene que estar cifrado usando la libreria @red-unica/libreria-cifrado|qQHubya9xfpRlrZBCQkbUfOfZe1rrL2wO4XHAdDSduw||| |EXPRESS_APP_BASE_URL_INT|URL Base para consultar el Token en de forma externa|https://prod-api.bancoazteca.com.mx|||

License

ISC ©