مستندات

اصول

حریم خصوصی و محدودیت‌ها

چه چیزی را هرگز نشان نمی‌دهیم، حدود نرخ، و استفاده‌ی مسئولانه از سرویس.

چه چیزی را هرگز نشان نمی‌دهیم

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

پاسخ‌های یکسان

برای ایمیلی که ناشناخته، تأییدنشده یا خصوصی است، سرویس دقیقاً یکسان جواب می‌دهد: تصویر پیش‌فرض برای آواتار و یک 404 ساده (یا null در lookup) برای API. چون هش محرمانه نیست (هر کس آدرسی را بداند هشش را می‌سازد)، پاسخ متفاوت نشان می‌داد چه کسانی حساب دارند. اتصال خودتان را طوری بسازید که هیچ‌وقت لازم نباشد این حالت‌ها را از هم جدا کند.

کاربر می‌تواند کل صفحه‌ی پروفایلش را هم مخفی کند؛ آن‌وقت صفحه، آواتارش و همه‌ی خروجی‌های JSON/Markdown/vCard/کارت 404 می‌دهند.

محدودیت‌ها

چه چیزی محدودیت
آدرس‌های آواتار (/avatar/{hash}، /{username}/avatar) ۶۰۰ درخواست در دقیقه برای هر IP
REST API ۶۰۰ درخواست در دقیقه برای هر کلید API (برای هر سایت قابل‌تنظیم)
profiles/lookup ۱۰۰ هش در هر درخواست
خروجی‌های عمومی (.json، .md، .vcf، .card) ۶۰ درخواست در دقیقه برای هر IP
اندازه‌ی آواتار (s) ۱۶ تا ۵۱۲ پیکسل
سایت برای هر کاربر ۱۰

وقتی از حدی بگذرید 429 همراه با Retry-After می‌گیرید.

کش

مؤدبانه کش کنید تا اتصال شما سریع بماند و از حدها خیلی دور باشد:

داده کش پیشنهادی
تصویر آواتار بگذارید مرورگر/CDN از Cache-Control پیروی کند (۱ ساعت) و از ETag استفاده کنید
پروفایل API تا ۱ ساعت
JSON عمومی تا ۵ دقیقه (Cache-Control: public, max-age=300)

اگر پروفایلی بعداً 404 داد، یعنی کاربر آن را مخفی یا حذف کرده: نمایش داده‌ای را که ذخیره کرده‌اید متوقف کنید.

آمار

هر کاربر می‌تواند ببیند آواتار، پروفایل، خروجی‌ها و داده‌ی API او چند بار و در کدام سایت‌ها استفاده شده است. فقط شمارنده‌ی روزانه ذخیره می‌کنیم: چند بار، و میزبان (host) سایتی که ارجاع داده (مثلاً blog.example.com). IP، مرورگر، کوکی یا هر چیز دیگری از بازدیدکننده را ذخیره نمی‌کنیم، و بازدید خودِ صاحب پروفایل، ربات‌ها و درخواست‌های HEAD شمرده نمی‌شوند. ردیف‌های قدیمی‌تر از ۹۰ روز پاک می‌شوند. فقط داده‌ی عکس یا پروفایل واقعی شمرده می‌شود، نه تصویر پیش‌فرض، پس نمی‌شود از آمار فهمید یک آدرس حساب دارد یا نه.

داده‌ی حساب شما

هر کاربر از بخش امنیت پنل می‌تواند همه‌ی چیزهایی را که از او داریم دانلود کند (یک ZIP با پروفایل، ایمیل‌ها، حساب‌های تأییدشده، سایت‌ها بدون کلید API، آمار و عکس‌ها) و حسابش را حذف کند. حذف، حساب، پروفایل، عکس‌ها، ایمیل‌ها، کلیدها و آمار را یک‌جا پاک می‌کند؛ نسخه‌های داخل پشتیبان وقتی آن پشتیبان می‌چرخد از بین می‌روند (حدود ۱۴ روز). ورود دومرحله‌ای (برنامه‌ی احراز هویت با کدهای بازیابی) و فهرست نشست‌های فعال هم همان‌جاست و درباره‌ی دستگاه جدید، تغییر گذرواژه یا ورود دومرحله‌ای و مسدودی به کاربر ایمیل می‌دهیم. متن کامل حقوقی در شرایط استفاده و سیاست حریم خصوصی است.

استفاده‌ی مسئولانه

  • هش‌ها را حدس نزنید و فهرست نکنید، و فهرست ایمیل‌ها را برای پیدا کردن اینکه چه کسی حساب دارد امتحان نکنید.
  • از داده‌ی پروفایل فقط برای نشان دادنش به مخاطبان همان شخص و در زمینه‌ای که خودش انتخاب کرده استفاده کنید، و با تازه‌سازی منظم، تغییرهای بعدی‌اش را رعایت کنید.
  • به X-Robots-Tag: noindex احترام بگذارید.
  • API را با کلیدتان از کد سمت کاربر صدا نزنید؛ از سرور خودتان عبور بدهید.
  • داده را به‌صورت مجموعه‌ی انبوه نفروشید و دوباره منتشر نکنید.

ممکن است کلیدی را که این قواعد را نقض می‌کند محدود یا غیرفعال کنیم. برای گزارش سوءاستفاده، یک issue در مخزن GitHub پروژه باز کنید؛ برای یک آسیب‌پذیری امنیتی از بخش Security مخزن (گزارش خصوصی) استفاده کنید، نه issue عمومی.