@globaling/client

Este módulo es un cliente HTTP diseñado para interactuar con el API de Globaling, permitiendo la autenticación y la realización de llamadas a diversas funciones del API de forma segura y eficiente.

Características

• Autenticación automática con tenantId y tenantSecret.
• Fácil de usar con promesas y async/await.
• Utiliza node-fetch y form-data para manejar peticiones y carga de datos.

Instalación

Instala el paquete usando npm:

npm install @globaling/client

O usando yarn:

yarn add @globaling/client

Uso

Para usar esta librería, primero importa y crea una instancia de GlobalingClient con tus credenciales de autenticación.

const GlobalingClient = require('@globaling/client');

const client = new GlobalingClient('your-tenant-id', 'your-tenant-secret');

Realizar una llamada a una función

Puedes realizar llamadas a las funciones del API usando el método callFunction. Aquí tienes un ejemplo de cómo enviar datos a un endpoint específico:

async function sendData() {
  const data = { key: 'value' };
  try {
    const response = await client.callFunction('endpoint-name', data);
    console.log(response);  // Manipula la respuesta como necesites
  } catch (error) {
    console.error('Error al realizar la llamada:', error);
  }
}

sendData();

Métodos

constructor(tenantId, tenantSecret)

Crea una nueva instancia del cliente.

• tenantId: String. El ID de tenant proporcionado para la autenticación.
• tenantSecret: String. El secreto de tenant proporcionado para la autenticación.

async callFunction(endpoint, data)

Realiza una llamada POST al endpoint especificado con los datos proporcionados.

• endpoint: String. El endpoint del API al que deseas llamar.
• data: Object. Un objeto que contiene los datos que se enviarán en la solicitud.

Contribuciones

Las contribuciones son siempre bienvenidas. Si deseas contribuir a este proyecto, por favor, crea un fork del repositorio y envía un pull request.

Licencia

Este proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE en este repositorio para más información.