API و مستندات

معرفی ساختار API، دسترسی‌ها و مسیر توسعه مستندات
SpeedScan API

مستندات API برای اتصال، تحلیل و توسعه آینده

این بخش برای مستندسازی API داخلی و عمومی SpeedScan طراحی شده است تا در آینده بتوان درخواست‌های تحلیل، دریافت نتایج، تاریخچه گزارش‌ها و یکپارچه‌سازی با سرویس‌های دیگر را از طریق یک ساختار شفاف و حرفه‌ای مدیریت کرد.

REST Ready JSON Responses Authentication Developer Docs Future Expansion
وضعیت مستندات در حال توسعه
نسخه اولیه v1
فرمت پاسخ JSON
هدف

چرا API برای SpeedScan مهم است؟

API این امکان را فراهم می‌کند که SpeedScan فقط به یک پنل گرافیکی محدود نباشد و بتواند به‌عنوان یک سرویس قابل اتصال در پروژه‌های دیگر نیز مورد استفاده قرار گیرد. این موضوع برای یکپارچه‌سازی با داشبوردهای مدیریتی، ابزارهای مانیتورینگ، سیستم‌های داخلی یا حتی سرویس‌های توسعه بسیار مهم است.

با فراهم شدن API، می‌توان فرآیند اجرای تست، دریافت گزارش، مشاهده تاریخچه و تحلیل داده‌ها را در خارج از رابط کاربری اصلی نیز در دسترس قرار داد و اکوسیستم SpeedScan را توسعه‌پذیرتر کرد.

نقشه راه

بخش‌هایی که بعداً تکمیل می‌شوند

Authentication
تعریف روش احراز هویت برای دسترسی امن به endpointها.
Endpoint Documentation
مستندسازی کامل مسیرها، پارامترها و ساختار داده‌ها.
Request / Response Examples
نمونه درخواست و پاسخ برای استفاده سریع توسعه‌دهندگان.
Versioning & Limits
مدیریت نسخه‌ها، محدودیت درخواست‌ها و رفتار API در مقیاس.
ساختار پیشنهادی

دسته‌بندی اولیه مسیرهای API

این بخش به‌عنوان پایه مستندات طراحی شده و بعداً می‌توان endpointهای واقعی را به آن اضافه کرد.

GET
/api/scans/
دریافت لیست تست‌های ثبت‌شده و تاریخچه نتایج.
POST
/api/scans/create/
ایجاد یک تست جدید برای URL مشخص‌شده.
GET
/api/scans/<id>/
دریافت جزئیات کامل یک تحلیل خاص.
GET
/api/stats/
نمایش خلاصه آماری از تست‌ها و متریک‌های کلی.
نمونه ساختار پاسخ

Response نمونه

{
  "status": "success",
  "scan_id": 128,
  "domain": "example.com",
  "form_factor": "mobile",
  "scores": {
    "performance": 92,
    "seo": 96,
    "accessibility": 88,
    "best_practices": 90
  },
  "created_at": "2026-03-20T12:40:00Z"
}
وضعیت فعلی

این صفحه فعلاً برای توسعه آینده آماده شده است

API
مستندات کامل به‌زودی تکمیل می‌شود
در نسخه‌های بعدی، اطلاعات کامل مربوط به endpointها، روش احراز هویت، نمونه درخواست‌ها، خطاها، محدودیت‌ها و راهنمای یکپارچه‌سازی در این صفحه اضافه خواهد شد.
چشم‌انداز توسعه

API در آینده چه نقشی خواهد داشت؟

API می‌تواند SpeedScan را از یک ابزار صرفاً رابط‌کاربری‌محور به یک سرویس قابل اتصال برای پروژه‌های دیگر تبدیل کند. این رویکرد امکان ساخت داشبوردهای سفارشی، مانیتورینگ دوره‌ای، اتصال به CI/CD و استفاده در سامانه‌های داخلی را فراهم خواهد کرد.

هدف این است که در آینده، SpeedScan علاوه بر رابط کاربری فعلی، یک لایه API مستند و توسعه‌پذیر هم داشته باشد تا استفاده از داده‌ها و گزارش‌ها در سناریوهای واقعی ساده‌تر شود.