1.0.2 • Published 2 years ago

@red-unica/libreria-consumidor-apis-backend v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

@red-unica/libreria-consumidor-apis-backend

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

Intalación

$ npm install @red-unica/libreria-consumidor-apis-backend

Uso

Cómo armar la peticion

const ConsumidorApisBackend = require('@irineocoria/libreria-consumidor-apis-backend');
const Arquitecturas = require('@irineocoria/libreria-consumidor-apis-backend/src/configuracion/Arquitecturas');
const axios = require('axios');
const CancelToken = axios.CancelToken;
...

// Recurso de APIGee a ejecutar
const url = "/identidad-digital/cliente-unico/clientes/indicadores/v1/busquedas";

// OPCIONAL, Objeto que será enviado en el body de la peticion
const cuerpo = {
	"idPais": 1, 
	"idCanal": 24, 
	"idSucursal": 9495, 
	"folio": 1549
};

// OPCIONAL, Parametros que se enviaran como query string de la peticion
const parametros = {
	"idPais": 1, 
	"idCanal": 24, 
	"idSucursal": 9495, 
	"folio": 1549
}; 

// OPCIONAL, Arreglo de arreglos cadenas indicando llave/valor de cada cabecero para la peticion.
const cabeceros = [
	['x-id-acceso', 'ASDCRSADACASFD'],
	['x-id-plataforma', '1']
];

// OPCIONAL, tiempo en milisegundos que debe esperar antes de cancelar la peticion
const timeout = 5000;

// OPCIONAL, Token de cancelacion de Axios para permitir la cancelacion de la peticion de forma externa.
const tokenCancelacion = CancelToken.source();

// OPCIONAL, Valor de la Enumeracion que indica de que celula deben usarse las credenciales
const arquitectura = Arquitecturas.INTERNA;

//OPCIONAL, En caso de que la celula cuente con más de unas credenciles, indica la posicion del arreglo que debe tomarse.
const credenciales = 0;

const peticion = { 
	url, 
	cuerpo, 
	parametros, 
	cabeceros, 
	timeout, 
	tokenCancelacion, 
	arquitectura, 
	credenciales, 
};

ConsumidorApisBackend.ejecutaPeticionGet(peticion);
ConsumidorApisBackend.ejecutaPeticionPost(peticion);
ConsumidorApisBackend.ejecutaPeticionPut(peticion);
ConsumidorApisBackend.ejecutaPeticionDelete(peticion);

Cómo realizar la peticion

// Opcion 1:
ConsumidorApisBackend.ejecutaPeticionPost(peticion)
	.then(respuesta=>{
		//Manipular la respuesta exitosa
	}).catch(error=>{
		//Manipular el error
    });

//Opcion 2:
try{
	const respuesta = await ConsumidorApisBackend.ejecutaPeticionPost(peticion);
	//Manipular la respuesta exitosa
}catch(error){
	//Manipular el error
}

Variables de entorno

EXPRESS_APP_JUEZ_FRASE_SECRETA

EXPRESS_APP_URL_TOKEN

EXPRESS_APP_BASE_URL_INT

EXPRESS_APP_BASE_URL_EXT

EXPRESS_APP_TIMEOUT_CONSUMO_APIS

EXPRESS_APP_APIGEE_CREDENCIALES

Asegurarse que las variables de ambiente esten definidas dentro del archivo .env correspondiente.

License

ISC ©

1.0.2

2 years ago

1.0.1

3 years ago

1.0.0

4 years ago