هر درخواستی که برنامه شما به API ابزارهای مدیریت پست ارسال میکند، باید شامل یک توکن مجوز باشد. این توکن همچنین برنامه شما را به گوگل معرفی میکند.
درباره پروتکلهای مجوزدهی
برنامه شما باید از OAuth 2.0 برای تأیید درخواستها استفاده کند. هیچ پروتکل تأیید دیگری پشتیبانی نمیشود. اگر برنامه شما از ورود با گوگل استفاده میکند، برخی از جنبههای تأیید برای شما انجام میشود.
تأیید درخواستها با OAuth 2.0
تمام درخواستها به API ابزارهای مدیریت پست باید توسط یک کاربر احراز هویت شده تأیید شوند.
جزئیات فرآیند مجوزدهی یا «جریان» برای OAuth 2.0 بسته به نوع برنامهای که مینویسید تا حدودی متفاوت است. فرآیند کلی زیر برای همه انواع برنامه اعمال میشود:
- وقتی برنامه خود را ایجاد میکنید، آن را با استفاده از کنسول API گوگل ثبت میکنید. سپس گوگل اطلاعاتی را که بعداً به آنها نیاز خواهید داشت، مانند شناسه کلاینت و رمز کلاینت، در اختیار شما قرار میدهد.
- API مربوط به ابزارهای مدیریت پست (Postmaster Tools) را در کنسول API گوگل فعال کنید. (اگر API در کنسول API فهرست نشده است، از این مرحله صرف نظر کنید.)
- وقتی برنامه شما نیاز به دسترسی به دادههای کاربر دارد، از گوگل درخواست محدوده خاصی از دسترسی را میکند.
- گوگل یک صفحه رضایتنامه به کاربر نمایش میدهد و از او میخواهد که به برنامه شما اجازه دهد تا برخی از دادههایش را درخواست کند.
- اگر کاربر تأیید کند، گوگل یک توکن دسترسی کوتاهمدت به برنامه شما میدهد.
- برنامه شما دادههای کاربر را درخواست میکند و توکن دسترسی را به درخواست پیوست میکند.
- اگر گوگل تشخیص دهد که درخواست شما و توکن معتبر هستند، دادههای درخواستی را برمیگرداند.
برخی از جریانها شامل مراحل اضافی مانند استفاده از توکنهای تازهسازی برای به دست آوردن توکنهای دسترسی جدید هستند. برای اطلاعات دقیق در مورد جریانها برای انواع مختلف برنامهها، به مستندات OAuth 2.0 گوگل مراجعه کنید.
اطلاعات دامنه OAuth 2.0 برای API ابزارهای Postmaster در اینجا آمده است:
| محدوده | معنی |
|---|---|
https://www.googleapis.com/auth/postmaster.readonly | دسترسی فقط خواندنی به دادههای ابزار مدیریت پست را امکانپذیر میکند. |
برای درخواست دسترسی با استفاده از OAuth 2.0، برنامه شما به اطلاعات دامنه و همچنین اطلاعاتی که گوگل هنگام ثبت برنامه شما ارائه میدهد (مانند شناسه کلاینت و رمز کلاینت) نیاز دارد.