@bernardo.paroli/inswich-sdk
v1.0.15-alpha
Published
Official TypeScript SDK for Inswitch services
Readme
Inswitch SDK
SDK oficial de TypeScript para los servicios de Inswitch. Proporciona una interfaz simple y tipada para interactuar con las APIs de Inswitch.
Instalación
npm install @bernardo.paroli/inswich-sdkCaracterísticas
- ✅ TypeScript nativo - Completamente tipado para mejor experiencia de desarrollo
- 🔐 Autenticación automática - Manejo automático de tokens y renovación
- 🌍 Multi-ambiente - Soporte para sandbox y producción
- ⚡ Cliente HTTP optimizado - Basado en Axios con configuración automática
Inicio Rápido
Configuración Básica
import { InswitchAPISDK } from '@bernardo.paroli/inswich-sdk';
const sdk = new InswitchAPISDK({
env: 'sbx', // 'sbx' para sandbox, 'prod' para producción
credentials: {
user: 'tu-usuario',
password: 'tu-contraseña',
apikey: 'tu-api-key'
},
usageType: 'client', // 'client' o 'management'
autoFetchToken: true // Obtiene el token automáticamente
});Ejemplo de Uso
// Obtener todas las entidades
const entities = await sdk.entities.getEntities();
console.log(entities.data);
// Crear una nueva entidad
const newEntity = await sdk.entities.createEntity({
name: 'Mi Empresa',
type: 'BUSINESS',
// ... otros campos
});
// Crear una billetera
const wallet = await sdk.wallets.createWallet({
entityId: 'entity-id',
currency: 'USD'
});Servicios Disponibles
🔐 Autenticación (sdk.auth)
Manejo de tokens de acceso y autenticación
🏢 Entidades (sdk.entities)
Gestión completa de entidades
🔍 KYC (sdk.kyc)
Servicios de verificación de identidad
Configuración Avanzada
Tipos de Uso
client: Para aplicaciones cliente que interactúan con entidades específicasmanagement: Para aplicaciones de gestión con permisos administrativos
Ambientes
sbx: Ambiente de sandbox para desarrollo y pruebasprod: Ambiente de producción
Headers Personalizados
Todos los métodos aceptan headers personalizados:
const customHeaders = {
'X-Custom-Header': 'valor',
'Authorization': 'Bearer custom-token'
};
const entities = await sdk.entities.getEntities({}, customHeaders);Tipos TypeScript
El SDK incluye tipos completos para todas las operaciones:
import {
Entity,
EntityRequest,
Wallet,
WalletRequest,
KYCCheckResponse,
Token
} from '@bernardo.paroli/inswich-sdk';Soporte
Para soporte técnico y documentación adicional, contacta al equipo de Inswitch.
