موارد الوكلاء
توثيق قابل للقراءة آليًا وملفات OpenAPI وأمثلة جاهزة للنسخ لوكلاء البرمجة وسير عمل المطورين.
نقاط دخول قابلة للقراءة آليًا
- /docs/llms.txt يمنح الوكلاء خريطة مختصرة ومنتقاة لتوثيق API من VeriMails.
- /llms-full.txt يجمع التوثيق الأساسي في ملف واحد قابل للقراءة بصيغة Markdown.
- /docs.md يلخّص توثيق المطورين العام.
- /openapi.json و /openapi.yaml تصف عقد API.
توثيق Markdown
استخدموا هذه الملفات عند تحميل VeriMails في أدوات البرمجة أو أنظمة التوثيق الداخلية أو سياق الأوامر.
- نظرة عامة على التوثيق
- مرجع API الأساسي
- أمثلة برمجية
- التحقق الفردي
- التحقق بالجملة
- أداة البحث عن البريد الإلكتروني
- رموز النتائج
- معالجة الأخطاء
ترتيب التنفيذ الموصى به
لتكامل جديد، ابدأوا بطلب تحقق فردي، ثم أضيفوا معالجة الأخطاء، ثم انتقلوا إلى سير عمل الجملة إذا كنتم تحتاجون إلى معالجة القوائم.
POST
/api/verify/single
POST
/api/bulk
POST
/api/find-email