Cómo utilizar el SDK de Botoi TypeScript con 5 ejemplos reales
Instale @botoi/sdk, llame a más de 150 puntos finales con seguridad de tipo completa, reintento automático y cero dependencias. Se incluyen cinco ejemplos de copiar y pegar.
Estás creando una aplicación Node.js y necesitas validar correos electrónicos, realizar capturas de pantalla y detectar PII en
tickets de soporte o generar códigos QR para recibos. podrías escribir fetch envoltorios,
manejar los reintentos, analizar los errores y esperar que los tipos permanezcan sincronizados con la API. O podrías instalar
un paquete.
La @botoi/sdk el paquete te da escrito acceso a más de 150 puntos finales con reintento automático, clases de error y cero dependencias. este post camina a través de cinco ejemplos de copiar y pegar que puede enviar hoy.
Instalar e inicializar
El SDK lee BOTOI_API_KEY de su entorno de forma predeterminada. ¿Sin clave API? Anónimo
El acceso funciona a 5 solicitudes por minuto y 100 por día. El paquete tiene cero dependencias y
requiere Node.js 20+.
Cinco cosas que puedes construir hoy
Escanee la entrada del usuario en busca de PII antes de iniciar sesión
Los tickets de soporte contienen correos electrónicos, números de teléfono y números de seguro social que los clientes pegan sin pensar.
Si registra esas cargas útiles, está almacenando PII que nunca solicitó. El pii.detect
El método encuentra datos confidenciales para que pueda redactarlos antes de que lleguen a su base de datos.
Respuesta:
Cada hallazgo incluye la entidad. type, el emparejado valueY la
start/end Posiciones de los personajes. Utilice esas compensaciones para reemplazar sensibles
texto con [REDACTED] antes de escribir en los registros.
Genere esquemas Zod a partir de respuestas API
Obtiene JSON de una API de terceros y necesita validación en tiempo de ejecución. Esquemas Zod escritos a mano para un
La intención de pago de Stripe de 30 campos requiere un tiempo que no tienes. El schema.jsonToZod
El método genera el esquema a partir de cualquier objeto JSON.
Producción:
Pegue el resultado en su código base, agregue import { z } from "zod"y tu
tenga tipos validados en tiempo de ejecución en menos de 30 segundos. Se manejan objetos y matrices anidados.
recursivamente.
Detectar qué pila tecnológica utiliza un competidor
La investigación de la competencia generalmente significa abrir DevTools y adivinar a partir de etiquetas de script. El
techDetect.detect El método escanea una URL y devuelve resultados categorizados; marcos,
análisis, CDN, proveedores de alojamiento y más.
Respuesta:
Cada tecnología incluye una puntuación y una categoría de confianza. Útil para inteligencia de ventas, mercado. investigar o auditar su propia pila.
Capture capturas de pantalla de página completa mediante programación
Imágenes de vista previa social, informes en PDF, pruebas de regresión visual. Todos necesitan capturas de pantalla. El
screenshot.capture El método devuelve un binario. Response objeto que puedas
escribir directamente en el disco.
Los puntos finales binarios (capturas de pantalla, archivos PDF, imágenes) devuelven un formato sin formato Response. Llamar
.arrayBuffer() para obtener los bytes. El punto final admite ventanas gráficas personalizadas, página completa
captura y formatos PNG/JPEG/WebP.
Generar códigos QR como SVG
Recibos, entradas para eventos, materiales de marketing. Los códigos QR aparecen en todas partes. El
qr.generate El método devuelve SVG de forma predeterminada, lo que significa escala infinita y tamaño pequeño.
tamaños de archivos.
La salida SVG es una cadena independiente que puede incrustar en HTML, guardar en un archivo o incluir en un PDF. Los colores personalizados, los niveles de corrección de errores y el tamaño son configurables.
Manejo de errores que le ayuda a recuperarse
El SDK exporta clases de errores escritos para cada modo de falla. Puede detectar errores específicos y responder de manera diferente a los límites de velocidad, fallas de autenticación y tiempos de espera.
El SDK reintenta automáticamente los errores 429 y 5xx con retroceso exponencial (hasta 3 intentos de forma predeterminada).
La mayoría de los fallos transitorios se resuelven sin que el código los toque. El BotoiRateLimitError
incluye un retryAfter propiedad en segundos, para que pueda crear alternativas basadas en colas
para cargas de trabajo de gran volumen.
Opciones de configuración
La configuración más simple lee todo del entorno:
Colocar BOTOI_API_KEY en tu .env archivo y el SDK lo recoge
automáticamente. No se necesitan argumentos de constructor.
What's included
El SDK expone 87 espacios de nombres de recursos que cubren búsqueda, procesamiento de texto, utilidades para desarrolladores, servicios de seguridad y validación, generación de imágenes y almacenamiento. Cada método está completamente tipificado; Pase el cursor sobre cualquier llamada en su editor para ver los parámetros de la solicitud y la forma de la respuesta.
Algunos espacios de nombres para comenzar:
botoi.ip,botoi.email,botoi.dnspara búsquedasbotoi.hash,botoi.jwt,botoi.uuidfor developer utilitiesbotoi.pii,botoi.encrypt,botoi.validatepor seguridadbotoi.qr,botoi.screenshot,botoi.ogfor image generationbotoi.schema,botoi.json,botoi.csvpara la transformación de datos
Consulte la referencia completa del SDK en /sdk/, o busque el paquete en npm.
FAQ
- ¿Funciona el SDK sin una clave API?
- Sí. El acceso anónimo ofrece 5 solicitudes por minuto y 100 por día. Pase una clave API para límites más altos.
- ¿Qué sucede cuando la API devuelve un 429?
- El SDK lo detecta y lo reintenta con un retroceso exponencial, respetando el encabezado Retry-After. Puede configurar maxRetries (predeterminado: 3).
- ¿Puedo usar el SDK en un navegador?
- El SDK está dirigido a Node.js 20+. Para usar el navegador, llame a la API REST directamente con fetch.
- ¿Cómo manejo respuestas binarias como capturas de pantalla y códigos QR?
- Los puntos finales binarios devuelven un objeto de respuesta. Llame a .arrayBuffer() para imágenes o .text() para cadenas SVG.
- ¿Existe un SDK de Python?
- Aún no. La API REST funciona desde cualquier idioma con soporte HTTP. Los ejemplos de curl se encuentran en los documentos de la API.
Empieza a construir con botoi
150+ endpoints de API para consultas, procesamiento de texto, generacion de imagenes y utilidades para desarrolladores. Plan gratuito, sin tarjeta de credito.