Comment utiliser le SDK Botoi TypeScript avec 5 exemples réels
Installez @botoi/sdk, appelez plus de 150 points de terminaison avec une sécurité de type complète, une nouvelle tentative automatique et aucune dépendance. Cinq exemples de copier-coller inclus.
Vous créez une application Node.js et devez valider les e-mails, capturer des captures d'écran, détecter les informations personnelles dans
prendre en charge les tickets ou générer des codes QR pour les reçus. Tu pourrais écrire fetch emballages,
gérer les tentatives, analyser les erreurs et espérer que les types resteront synchronisés avec l'API. Ou vous pouvez installer
un paquet.
La @botoi/sdk le paquet vous donne tapé accès à plus de 150 points de terminaison avec nouvelle tentative automatique, classes d'erreur et zéro dépendance. Ce message marche à travers cinq exemples de copier-coller que vous pouvez expédier dès aujourd'hui.
Installer et initialiser
Le SDK lit BOTOI_API_KEY de votre environnement par défaut. Pas de clé API ? Anonyme
l'accès fonctionne à 5 requêtes par minute et 100 par jour. Le package n'a aucune dépendance et
nécessite Node.js 20+.
Cinq choses que vous pouvez construire aujourd'hui
Analyser les entrées de l'utilisateur pour rechercher des informations personnelles avant de vous connecter
Les tickets d'assistance contiennent des e-mails, des numéros de téléphone et des SSN que les clients collent sans réfléchir.
Si vous enregistrez ces charges utiles, vous stockez des informations personnelles que vous n'avez jamais demandées. Le pii.detect
La méthode trouve les données sensibles afin que vous puissiez les rédiger avant qu'elles n'atteignent votre base de données.
Réponse:
Chaque résultat inclut l'entité type, le correspondant value, et le
start/end positions des personnages. Utilisez ces décalages pour remplacer les éléments sensibles
texte avec [REDACTED] avant d'écrire dans les journaux.
Générer des schémas Zod à partir des réponses API
Vous obtenez JSON à partir d'une API tierce et avez besoin d'une validation d'exécution. Écrire à la main des schémas Zod pour un
L'intention de paiement Stripe à 30 champs prend du temps que vous n'avez pas. Le schema.jsonToZod
La méthode génère le schéma à partir de n’importe quel objet JSON.
Sortir:
Collez la sortie dans votre base de code, ajoutez import { z } from "zod", et toi
avoir des types validés à l’exécution en moins de 30 secondes. Les objets et tableaux imbriqués sont gérés
récursivement.
Détectez la pile technologique utilisée par un concurrent
La recherche de concurrents signifie généralement ouvrir DevTools et deviner à partir des balises de script. Le
techDetect.detect la méthode analyse une URL et renvoie des résultats catégorisés ; des cadres,
analyses, CDN, fournisseurs d'hébergement, etc.
Réponse:
Chaque technologie comprend un score de confiance et une catégorie. Utile pour la veille commerciale, le marché recherche ou audit de votre propre pile.
Capturer des captures d'écran pleine page par programme
Images d'aperçu social, rapports PDF, tests de régression visuelle. Ils ont tous besoin de captures d'écran. Le
screenshot.capture la méthode renvoie un binaire Response objet tu peux
écrire directement sur le disque.
Les points de terminaison binaires (captures d'écran, PDF, images) renvoient un brut Response. Appel
.arrayBuffer() pour obtenir les octets. Le point de terminaison prend en charge les fenêtres personnalisées, pleine page
capture et formats PNG/JPEG/WebP.
Générer des codes QR au format SVG
Reçus, billets d’événements, matériel marketing. Les codes QR apparaissent partout. Le
qr.generate La méthode renvoie SVG par défaut, ce qui signifie une mise à l'échelle infinie et un minuscule
tailles de fichiers.
La sortie SVG est une chaîne autonome que vous pouvez intégrer au format HTML, enregistrer dans un fichier ou inclure dans un PDF. Les couleurs personnalisées, les niveaux de correction d'erreur et la taille sont tous configurables.
Gestion des erreurs qui vous aide à récupérer
Le SDK exporte les classes d’erreurs typées pour chaque mode de défaillance. Vous pouvez détecter des erreurs spécifiques et réagir différemment aux limites de débit, aux échecs d’authentification et aux délais d’attente.
Le SDK réessaye automatiquement les erreurs 429 et 5xx avec une interruption exponentielle (jusqu'à 3 tentatives par défaut).
La plupart des échecs transitoires se résolvent sans que votre code ne les touche. Le BotoiRateLimitError
comprend un retryAfter propriété en quelques secondes, afin que vous puissiez créer des solutions de secours basées sur la file d'attente
pour les charges de travail à volume élevé.
Options de configuration
La configuration la plus simple lit tout ce qui se trouve dans l'environnement :
Ensemble BOTOI_API_KEY dans votre .env fichier et le SDK le récupère
automatiquement. Aucun argument de constructeur n'est nécessaire.
Ce qui est inclus
Le SDK expose 87 espaces de noms de ressources couvrant la recherche, le traitement de texte, les utilitaires de développement, services de sécurité et de validation, de génération d’images et de stockage. Chaque méthode est entièrement typée ; survolez n'importe quel appel dans votre éditeur pour voir les paramètres de la demande et la forme de la réponse.
Quelques espaces de noms pour commencer :
botoi.ip,botoi.email,botoi.dnspour les recherchesbotoi.hash,botoi.jwt,botoi.uuidpour les utilitaires de développementbotoi.pii,botoi.encrypt,botoi.validatepour la sécuritébotoi.qr,botoi.screenshot,botoi.ogpour la génération d'imagesbotoi.schema,botoi.json,botoi.csvpour la transformation des données
Consultez la référence complète du SDK sur /sdk/, ou parcourez le package sur npm.
FAQ
- Le SDK fonctionne-t-il sans clé API ?
- Oui. L'accès anonyme donne 5 requêtes par minute et 100 par jour. Transmettez une clé API pour des limites plus élevées.
- Que se passe-t-il lorsque l'API renvoie un 429 ?
- Le SDK l'attrape et réessaye avec un intervalle exponentiel, en respectant l'en-tête Retry-After. Vous pouvez configurer maxRetries (par défaut : 3).
- Puis-je utiliser le SDK dans un navigateur ?
- Le SDK cible Node.js 20+. Pour une utilisation dans le navigateur, appelez directement l'API REST avec fetch.
- Comment gérer les réponses binaires telles que les captures d'écran et les codes QR ?
- Les points de terminaison binaires renvoient un objet Response. Appelez .arrayBuffer() pour les images ou .text() pour les chaînes SVG.
- Existe-t-il un SDK Python ?
- Pas encore. L'API REST fonctionne à partir de n'importe quel langage prenant en charge HTTP. Des exemples de curl se trouvent dans la documentation de l'API.
Commencez a construire avec botoi
150+ endpoints API pour la recherche, le traitement de texte, la generation d'images et les utilitaires pour developpeurs. Offre gratuite, sans carte bancaire.