در پایان، برنامه‌ای را وادار کرده‌اید با یک کلید این سایت را فراخوانی کند.
پیش از شروع
کلیدی لازم است که دامنه‌های موردنیاز فراخوانی‌ها را داشته باشد. سمت سرور نگهش دارید: هیچ‌وقت در صفحهٔ وب یا برنامهٔ موبایل نگذارید.
مراحل
۱. کلید را در یک سرآیند درخواست به نام X-API-KEY بگذارید، مثلاً X-API-KEY: ak_….
۲. API یِ tRPC سایت را زیر /api/trpc/ فراخوانی کنید. تنها سطحی است که کلیدها را می‌خواند؛ نقطهٔ پایانی REST جداگانه‌ای برایشان نیست.
۳. وضعیت هر پاسخ را بررسی کنید (پایین).
چه چیزی می‌بینید
- موفقیت وقتی کلید معتبر است و دامنه‌ای را که فراخوانی لازم دارد دارد.
- ۴۰۱ وقتی کلید نیست، یا غلط، ابطال‌شده یا منقضی است. پاسخ نمی‌گوید کدام، پس از کسی که کلید را داده بپرسید.
- ۴۰۳ وقتی کلید دامنه‌ای را که فراخوانی لازم دارد ندارد؛ پیام نامش را می‌آورد. همچنین ۴۰۳ برای فراخوانی‌هایی که دربارهٔ «کاربر فراخوان»اند (مثل «وظایف من»)، چون کلید آدم نیست: به‌جایش اجازهٔ گسترده‌تر را بخواهید.
- ۴۰۰ برای فیلد غایب یا نامعتبر، مثل آدم‌ها.
اگر مشکلی پیش آمد
- کلید وقتی ابطال شود و وقتی کسی که ساخته غیرفعال شود فوراً از کار می‌افتد.
- وقتی کلید هست دامنه‌هایش تنها مرجع‌اند؛ فرستادن کوکی نشست هم چیزی اضافه نمی‌کند.
- محدودیتی برای هر کلید نیست، فقط محدودیت کلی سایت برای هر نشانی (حدود ۱۰۰۰ درخواست در دقیقه).
- کلید روی هر هاست‌نامه‌ای که نصب به آن پاسخ می‌دهد کار می‌کند و نمی‌شود آن را به یک IP محدود کرد.