مستندات

شروع

شروع کار

Avatarak.ir چه می‌کند و دو راه اتصال به آن: آدرس آواتار و REST API.

Avatarak.ir یک آدرس ایمیل را به یک آواتار و یک پروفایل عمومی تبدیل می‌کند. کاربر یک بار عکس و اطلاعاتش را ثبت می‌کند؛ هر سایتی که ایمیلش را بداند می‌تواند آن‌ها را نشان بدهد.

دو راه برای استفاده هست:

آدرس آواتار REST API
چه می‌گیرید عکس کاربر اطلاعات پروفایل: نام، بیو، وب‌سایت، شبکه‌ها، آواتار
کلید API لازم نیست لازم است (رایگان)
از کجا صدا بزنید هرجا، حتی داخل تگ <img> سرور شما

شروع سریع

۱. ایمیل را هش کنید. همه‌ی آدرس‌ها از هش SHA-256 ایمیل ساخته می‌شوند، نه خود ایمیل. ساخت شناسه را ببینید.

// sha256 of "myemailaddress@example.com"
const hash = '84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee';

۲. آواتار را نشان بدهید. بدون کلید و بدون ثبت‌نام:

<img src="https://avatarak.ir/avatar/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee?s=96&d=mp"
     width="96" height="96" alt="">

۳. (اختیاری) اطلاعات پروفایل را بگیرید. یک کلید API بسازید و از سرور خودتان صدا بزنید:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://avatarak.ir/api/v1/profiles/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee

آدرس‌های پایه

کاربرد آدرس
آواتار با هش ایمیل https://avatarak.ir/avatar/{hash}
REST API https://avatarak.ir/api/v1
صفحه‌ی عمومی یک پروفایل https://avatarak.ir/{username}
پروفایل به‌صورت JSON / Markdown / vCard / کارت قابل‌جاسازی https://avatarak.ir/{username}.json · .md · .vcf · .card

کاربر چه چیزی را کنترل می‌کند

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

قدم‌های بعد