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

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

Intalación

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

Uso

Cómo armar la peticion

import ConsumidorApisFrontEnd, {  CelulasRedUnica, OrigenApis } from '@red-unica/libreria-consumidor-apis-frontend';
import axios from '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 celula = CelulasRedUnica.RED_UNICA;

//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;

//OPCIONAL, En caso de que el consumo tenga que ser de AWS
const origenApis = OrigenApis.AWS;

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

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

Cómo realizar la peticion

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

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

Variables de entorno

REACT_APP_JUEZ_FRASE_SECRETA

REACT_APP_URL_TOKEN

REACT_APP_URL_TOKEN_SERVICIO

REACT_APP_URL_BASE_INT

REACT_APP_URL_BASE_EXT

REACT_APP_URL_BASE_AWS_INT

REACT_APP_URL_BASE_AWS_EXT

REACT_APP_URL_BASE_SERVICIO_INT

REACT_APP_URL_BASE_SERVICIO_EXT

REACT_APP_TIMEOUT_CONSUMO_APIS

REACT_APP_TIPO_ARQUITECTURA_PC

REACT_APP_TIPO_ARQUITECTURA_TABLET

REACT_APP_TIPO_ARQUITECTURA_MOVIL

REACT_APP_TIPO_MANEJADOR_CREDENCIALES_TABLET

REACT_APP_TIPO_MANEJADOR_CREDENCIALES_MOVIL

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

License

ISC ©