Langsung ke konten
Tutorial

Cara menggunakan Botoi TypeScript SDK dengan 5 contoh nyata

| 7 min read

Instal @botoi/sdk, hubungi 150+ titik akhir dengan keamanan tipe penuh, coba ulang otomatis, dan nol ketergantungan. Lima contoh salin-tempel disertakan.

TypeScript code in a VS Code editor
Photo by Safar Safarov on Unsplash

Anda sedang membuat aplikasi Node.js dan perlu memvalidasi email, mengambil tangkapan layar, mendeteksi PII mendukung tiket, atau menghasilkan kode QR untuk tanda terima. Anda bisa menulis fetch pembungkus, menangani percobaan ulang, mengurai kesalahan, dan berharap tipenya tetap sinkron dengan API. Atau Anda bisa menginstal satu paket.

Itu @botoi/sdk paket memberi Anda mengetik akses ke 150+ titik akhir dengan coba ulang otomatis, kelas kesalahan, dan ketergantungan nol. Posting ini berjalan melalui lima contoh salin-tempel yang dapat Anda kirimkan hari ini.

Instal dan inisialisasi

SDK membaca BOTOI_API_KEY dari lingkungan Anda secara default. Tidak ada kunci API? Anonim akses bekerja dengan 5 permintaan per menit dan 100 per hari. Paket ini tidak memiliki ketergantungan dan membutuhkan Node.js 20+.

Lima hal yang dapat Anda bangun hari ini

Pindai input pengguna untuk PII sebelum masuk

Tiket dukungan berisi email, nomor telepon, dan SSN yang ditempelkan pelanggan tanpa berpikir panjang. Jika Anda mencatat payload tersebut, Anda menyimpan PII yang tidak pernah Anda minta. Itu pii.detect metode menemukan data sensitif sehingga Anda dapat menyuntingnya sebelum data tersebut masuk ke database Anda.

Tanggapan:

Setiap temuan mencakup entitas type, yang cocok value, dan itu start/end posisi karakter. Gunakan offset tersebut untuk menggantikan sensitif teks dengan [REDACTED] sebelum menulis ke log.

Hasilkan skema Zod dari respons API

Anda mendapatkan JSON dari API pihak ketiga dan memerlukan validasi waktu proses. Skema Zod tulisan tangan untuk a Niat pembayaran Stripe 30 bidang membutuhkan waktu yang tidak Anda miliki. Itu schema.jsonToZod metode menghasilkan skema dari objek JSON apa pun.

Keluaran:

Rekatkan hasilnya ke basis kode Anda, tambahkan import { z } from "zod", dan kamu memiliki tipe yang divalidasi waktu proses dalam waktu kurang dari 30 detik. Objek dan array bersarang ditangani secara rekursif.

Deteksi tumpukan teknologi apa yang digunakan pesaing

Riset pesaing biasanya berarti membuka DevTools dan menebak-nebak dari tag skrip. Itu techDetect.detect metode memindai URL dan mengembalikan hasil yang dikategorikan; kerangka kerja, analitik, CDN, penyedia hosting, dan banyak lagi.

Tanggapan:

Setiap teknologi mencakup skor dan kategori kepercayaan diri. Berguna untuk intelijen penjualan, pasar meneliti, atau mengaudit tumpukan Anda sendiri.

Ambil tangkapan layar satu halaman penuh secara terprogram

Gambar pratinjau sosial, laporan PDF, tes regresi visual. Mereka semua membutuhkan tangkapan layar. Itu screenshot.capture metode mengembalikan biner Response objek yang Anda bisa menulis langsung ke disk.

Titik akhir biner (tangkapan layar, PDF, gambar) mengembalikan mentah Response. Panggilan .arrayBuffer() untuk mendapatkan byte. Titik akhir mendukung area pandang khusus, satu halaman penuh pengambilan, dan format PNG/JPEG/WebP.

Hasilkan kode QR sebagai SVG

Kwitansi, tiket acara, materi pemasaran. Kode QR muncul di mana-mana. Itu qr.generate metode mengembalikan SVG secara default, yang berarti penskalaan tak terbatas dan kecil ukuran file.

Output SVG adalah string mandiri yang dapat Anda sematkan dalam HTML, simpan ke file, atau sertakan sebuah PDF. Warna khusus, tingkat koreksi kesalahan, dan ukuran semuanya dapat dikonfigurasi.

Penanganan kesalahan yang membantu Anda pulih

SDK mengekspor kelas kesalahan yang diketik untuk setiap mode kegagalan. Anda dapat menangkap kesalahan tertentu dan merespons secara berbeda terhadap batas kecepatan, kegagalan autentikasi, dan batas waktu.

SDK secara otomatis mencoba ulang kesalahan 429 dan 5xx dengan backoff eksponensial (hingga 3 upaya secara default). Sebagian besar kegagalan sementara teratasi tanpa kode Anda menyentuhnya. Itu BotoiRateLimitError termasuk a retryAfter properti dalam hitungan detik, sehingga Anda dapat membuat fallback berbasis antrean untuk beban kerja bervolume tinggi.

Opsi konfigurasi

Konfigurasi paling sederhana membaca semuanya dari lingkungan:

Mengatur BOTOI_API_KEY di dalam kamu .env file dan SDK mengambilnya secara otomatis. Tidak diperlukan argumen konstruktor.

Apa yang termasuk

SDK memaparkan 87 ruang nama sumber daya yang mencakup pencarian, pemrosesan teks, utilitas pengembang, keamanan dan validasi, pembuatan gambar, dan layanan penyimpanan. Setiap metode diketik sepenuhnya; arahkan kursor ke panggilan apa pun di editor Anda untuk melihat parameter permintaan dan bentuk respons.

Beberapa namespace untuk memulai:

  • botoi.ip, botoi.email, botoi.dns untuk pencarian
  • botoi.hash, botoi.jwt, botoi.uuid untuk utilitas pengembang
  • botoi.pii, botoi.encrypt, botoi.validate untuk keamanan
  • botoi.qr, botoi.screenshot, botoi.og untuk pembuatan gambar
  • botoi.schema, botoi.json, botoi.csv untuk transformasi data

Lihat referensi SDK selengkapnya di /sdk/, atau telusuri paket di npm.

FAQ

Apakah SDK berfungsi tanpa kunci API?
Ya. Akses anonim memberikan 5 permintaan per menit dan 100 per hari. Berikan kunci API untuk batas yang lebih tinggi.
Apa yang terjadi jika API mengembalikan 429?
SDK menangkapnya dan mencoba lagi dengan backoff eksponensial, dengan memperhatikan header Retry-After. Anda dapat mengkonfigurasi maxRetries (default: 3).
Bisakah saya menggunakan SDK di browser?
SDK menargetkan Node.js 20+. Untuk penggunaan browser, panggil REST API secara langsung dengan mengambil.
Bagaimana cara menangani respons biner seperti tangkapan layar dan kode QR?
Titik akhir biner mengembalikan objek Respons. Panggil .arrayBuffer() untuk gambar atau .text() untuk string SVG.
Apakah ada SDK Python?
Belum. REST API berfungsi dari bahasa apa pun dengan dukungan HTTP. contoh curl ada di dokumen API.

Mulai membangun dengan botoi

150+ endpoint API untuk pencarian, pemrosesan teks, pembuatan gambar, dan utilitas developer. Paket gratis, tanpa kartu kredit.