Introducción al SDK de TypeScript

Bienvenido al SDK de Retorna para TypeScript/Node.js. Este SDK te permite integrar de forma sencilla y segura los servicios B2B de Retorna dentro de tus aplicaciones.

Qué es el SDK de Retorna

El SDK de Retorna es una biblioteca que permite a las empresas realizar pagos, cobros, consultas de transacciones, conciliaciones, creación de órdenes y automatización de flujos financieros mediante una interfaz unificada y fácil de usar.

Características Principales

• ✅ Autenticación Automática: El SDK maneja automáticamente la autenticación OAuth2 y la renovación de tokens
• ✅ Firmas Digitales: Soporte completo para firmas RSA para seguridad adicional
• ✅ Manejo de Errores: Sistema robusto de manejo de errores con categorización
• ✅ Tipado Fuerte: Tipos completos de TypeScript para un desarrollo seguro
• ✅ Logging Configurable: Logging ajustable para debugging

Requisitos

• Node.js 18 o superior
• npm, yarn o pnpm

Instalación

npm install retorna-typescript-sdk dotenv
# o
yarn add retorna-typescript-sdk dotenv
# o
pnpm add retorna-typescript-sdk dotenv

Inicio Rápido

import dotenv from "dotenv";
import { RetornaEnvironment, RetornaTypeScriptSDKConfigBuilder } from "retorna-typescript-sdk";

dotenv.config();

const client = new RetornaTypeScriptSDKConfigBuilder()
  .environment(process.env.RETORNA_ENV as RetornaEnvironment)
  .clientId(process.env.RETORNA_CLIENT_ID!)
  .clientSecret(process.env.RETORNA_CLIENT_SECRET!)
  .privateKey(process.env.RETORNA_PRIVATE_KEY!)
  .buildClient();

const balance = await client.getBalance.list();

Uso con TypeScript

El SDK incluirá tipos completos de TypeScript:

import { RetornaClient, CreateOrderInput, OrderResponse } from '@retorna/sdk';

async function createOrder(): Promise<OrderResponse> {
  const input: CreateOrderInput = {
    // ... configuración
  };
  
  const order = await client.order.createPayoutOrder(input);
  return order;
}

Estado del Desarrollo

El SDK de TypeScript está actualmente en desarrollo. La documentación completa estará disponible cuando se lance la versión inicial.

Notificaciones

Para recibir notificaciones cuando el SDK de TypeScript esté disponible, suscríbete a nuestras actualizaciones o visita nuestro GitHub.

Mientras Tanto

Si necesitas usar Retorna ahora, considera usar el SDK de Java que está completamente funcional.

• Instalación - Instala el SDK en tu proyecto
• Configuración - Ajusta el cliente y variables de entorno
• Autenticación - Aprende cómo funciona OAuth2 en el SDK