توسعه · مستندات رسمی

API توسعه‌دهندگان

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

دسترسی

اصول طراحی

  • دسترسی عمومی فقط‌خواندنی به داده‌های عمومی بلاک‌چین.
  • هیچ عملیات نوشتن، امضا یا مدیریت کیف پول انجام نمی‌شود.
  • هیچ افشای مستقیم RPC گره وجود ندارد.
  • پاسخ‌های ذخیره‌شده و محدودسازی نرخ برای محافظت از زیرساخت.
  • عدم دسترسی به API بدون تأثیر بر مشاهدهٔ وب‌سایت.
  • مستندسازی طرح‌ها، کدهای خطا و محدودیت‌ها پیش از راه‌اندازی.

منابع پیش‌نظر

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

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

یکپارچه‌سازی در وب‌سایت

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

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