تخطي إلى المحتوى
Tutorial

كيفية استخدام Botoi TypeScript SDK مع 5 أمثلة حقيقية

| 7 min read

قم بتثبيت @botoi/sdk، واتصل بأكثر من 150 نقطة نهاية مع أمان كامل للنوع، وإعادة المحاولة التلقائية، وعدم التبعيات. تم تضمين خمسة أمثلة للنسخ واللصق.

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

أنت تقوم بإنشاء تطبيق Node.js وتحتاج إلى التحقق من صحة رسائل البريد الإلكتروني والتقاط لقطات الشاشة واكتشاف معلومات تحديد الهوية الشخصية (PII). تذاكر الدعم، أو إنشاء رموز QR للإيصالات. يمكنك الكتابة fetch مغلفة, التعامل مع إعادة المحاولة، وتحليل الأخطاء، ونأمل أن تظل الأنواع متزامنة مع واجهة برمجة التطبيقات. أو يمكنك تثبيت حزمة واحدة.

ال @botoi/sdk الحزمة تعطيك كتابتها الوصول إلى أكثر من 150 نقطة نهاية مع إعادة المحاولة التلقائية وفئات الأخطاء وعدم التبعيات. هذا المنصب يمشي من خلال خمسة أمثلة للنسخ واللصق يمكنك شحنها اليوم.

التثبيت والتهيئة

يقرأ SDK BOTOI_API_KEY من بيئتك بشكل افتراضي. لا يوجد مفتاح API؟ مجهول الوصول يعمل بمعدل 5 طلبات في الدقيقة و 100 في اليوم. تحتوي الحزمة على صفر تبعيات و يتطلب Node.js 20+.

خمسة أشياء يمكنك بناءها اليوم

قم بمسح إدخال المستخدم لمعرفة معلومات تحديد الهوية الشخصية (PII) قبل التسجيل

تحتوي تذاكر الدعم على رسائل البريد الإلكتروني وأرقام الهواتف وأرقام الضمان الاجتماعي التي يلصقها العملاء دون تفكير. إذا قمت بتسجيل هذه الحمولات، فإنك تقوم بتخزين معلومات تحديد الهوية الشخصية (PII) التي لم تطلبها أبدًا. ال pii.detect تبحث الطريقة عن بيانات حساسة حتى تتمكن من تنقيحها قبل أن تصل إلى قاعدة البيانات الخاصة بك.

إجابة:

كل نتيجة تشمل الكيان type، المتطابقة value، و start/end مواقف الشخصيات. استخدم هذه الإزاحات لتحل محل العناصر الحساسة النص مع [REDACTED] قبل الكتابة إلى السجلات.

إنشاء مخططات Zod من استجابات API

تحصل على JSON من واجهة برمجة تطبيقات تابعة لجهة خارجية وتحتاج إلى التحقق من صحة وقت التشغيل. مخططات Zod للكتابة اليدوية لـ a تستغرق نية الدفع ذات 30 حقلاً وقتًا لا تملكه. ال schema.jsonToZod تنشئ الطريقة المخطط من أي كائن JSON.

الإخراج:

الصق الإخراج في قاعدة التعليمات البرمجية الخاصة بك، أضف import { z } from "zod"وأنت لديك أنواع تم التحقق من صحتها في وقت التشغيل في أقل من 30 ثانية. يتم التعامل مع الكائنات والمصفوفات المتداخلة بشكل متكرر.

اكتشف مجموعة التكنولوجيا التي يستخدمها المنافس

عادةً ما يعني البحث عن المنافسين فتح DevTools والتخمين من خلال علامات البرنامج النصي. ال techDetect.detect تقوم الطريقة بمسح عنوان URL وإرجاع النتائج المصنفة؛ الأطر, التحليلات وشبكات CDN وموفري الاستضافة والمزيد.

إجابة:

تتضمن كل تقنية درجة ثقة وفئة. مفيدة لذكاء المبيعات والسوق البحث، أو تدقيق المكدس الخاص بك.

التقاط لقطات شاشة لكامل الصفحة برمجياً

صور المعاينة الاجتماعية وتقارير PDF واختبارات الانحدار المرئي. انهم جميعا بحاجة إلى لقطات الشاشة. ال screenshot.capture تقوم الطريقة بإرجاع ثنائي Response كائن يمكنك الكتابة مباشرة على القرص.

تقوم نقاط النهاية الثنائية (لقطات الشاشة وملفات PDF والصور) بإرجاع ملف خام Response. يتصل .arrayBuffer() للحصول على البايتات. تدعم نقطة النهاية إطارات العرض المخصصة والصفحة الكاملة التقاط وتنسيقات PNG/JPEG/WebP.

قم بإنشاء رموز QR بتنسيق SVG

الإيصالات وتذاكر الأحداث والمواد التسويقية. تظهر رموز QR في كل مكان. ال qr.generate تُرجع الطريقة SVG افتراضيًا، مما يعني تحجيمًا لا نهائيًا وصغيرًا أحجام الملفات.

إن مخرجات SVG عبارة عن سلسلة قائمة بذاتها يمكنك تضمينها في HTML أو حفظها في ملف أو تضمينها في قوات الدفاع الشعبي. الألوان المخصصة ومستويات تصحيح الأخطاء والحجم كلها قابلة للتكوين.

معالجة الأخطاء تساعدك على التعافي

يقوم SDK بتصدير فئات الأخطاء المكتوبة لكل وضع فشل. يمكنك اكتشاف أخطاء محددة و تستجيب بشكل مختلف لحدود المعدل، وفشل المصادقة، والمهلات.

يقوم SDK بإعادة المحاولة التلقائية للأخطاء 429 و5xx مع التراجع الأسي (ما يصل إلى 3 محاولات بشكل افتراضي). يتم حل معظم حالات الفشل العابرة دون أن تلمسها التعليمات البرمجية الخاصة بك. ال BotoiRateLimitError يتضمن أ retryAfter الخاصية في ثوانٍ، حتى تتمكن من إنشاء عمليات احتياطية قائمة على قائمة الانتظار لأحمال العمل كبيرة الحجم.

خيارات التكوين

أبسط تكوين يقرأ كل شيء من البيئة:

تعيين BOTOI_API_KEY في الخاص بك .env الملف ويلتقطه SDK تلقائيا. لا حاجة للوسائط المنشئة.

ما هو مدرج

يعرض SDK 87 مساحة أسماء موارد تغطي البحث ومعالجة النصوص والأدوات المساعدة للمطورين، خدمات الأمن والتحقق وتوليد الصور والتخزين. تتم كتابة كل طريقة بالكامل؛ قم بالتمرير فوق أي مكالمة في المحرر الخاص بك لرؤية معلمات الطلب وشكل الاستجابة.

بعض مساحات الأسماء للبدء بها:

  • botoi.ip, botoi.email, botoi.dns لعمليات البحث
  • botoi.hash, botoi.jwt, botoi.uuid للمرافق المطور
  • botoi.pii, botoi.encrypt, botoi.validate للأمن
  • botoi.qr, botoi.screenshot, botoi.og لتوليد الصورة
  • botoi.schema, botoi.json, botoi.csv لتحويل البيانات

راجع مرجع SDK الكامل على /سك/، أو تصفح الحزمة على npm.

FAQ

هل يعمل SDK بدون مفتاح API؟
نعم. الوصول المجهول يعطي 5 طلبات في الدقيقة و 100 في اليوم. قم بتمرير مفتاح API للحدود الأعلى.
ماذا يحدث عندما تقوم واجهة برمجة التطبيقات (API) بإرجاع 429؟
يلتقطها SDK ويعيد المحاولة مع التراجع الأسي، مع احترام رأس "إعادة المحاولة بعد". يمكنك تكوين maxRetries (الافتراضي: 3).
هل يمكنني استخدام SDK في المتصفح؟
يستهدف SDK Node.js 20+. لاستخدام المتصفح، اتصل بـ REST API مباشرةً باستخدام ميزة الجلب.
كيف أتعامل مع الاستجابات الثنائية مثل لقطات الشاشة ورموز QR؟
تقوم نقاط النهاية الثنائية بإرجاع كائن الاستجابة. اتصل بـ .arrayBuffer() للصور أو .text() لسلاسل SVG.
هل هناك بايثون SDK؟
ليس بعد. تعمل واجهة REST API من أي لغة مع دعم HTTP. أمثلة الضفيرة موجودة في مستندات API.

ابدأ البناء مع botoi

أكثر من 150 نقطة نهاية API للبحث ومعالجة النصوص وتوليد الصور وأدوات المطورين. باقة مجانية، بدون بطاقة ائتمان.