احراز هویت

کلیدهای API

درخواست‌های API مشتری را با Authorization: Bearer re_… احراز هویت کنید. کلیدها به یک فضای کاری تعلق دارند و هرگز نباید در مرورگر، اپلیکیشن موبایل یا دسکتاپ، قالب یا محتوای ایمیل قرار داده شوند.

Authorization: Bearer re_your_key_here

نشست‌های مرورگر

داشبورد از یک کوکی نشست HTTP-only و قابل‌ابطال استفاده می‌کند. تغییرات صورتحساب و ایجاد یا ابطال کلید API به این نشست مرورگر نیاز دارند و با کلیدهای bearer در دسترس نیستند. یک کلید bearer می‌تواند همان وضعیت حساب، مصرف و صورتحساب را از طریق GET /account، analytics داشبورد را از طریق GET /analytics و metadata کلیدها (نام، پیشوند، آخرین استفاده) را از طریق GET /keys بخواند.

چرخش کلید

1. از یک نشست احرازشده در داشبورد، کلید جایگزین بسازید.
2. کلید جایگزین را در همه سرویس‌های فراخواننده مستقر کنید.
3. مطمئن شوید ترافیک از پیشوند جدید استفاده می‌کند.
4. کلید قدیمی را باطل کنید.

خطاهای احراز هویت

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

{
  "error": {
    "message": "Unauthorized — provide a valid API key or session",
    "status": 401
  }
}