شروع سریع PHP

این راهنمای شروع سریع توضیح می‌دهد که چگونه یک برنامه خط فرمان PHP ساده راه‌اندازی کنید که درخواست‌هایی به YouTube Data API ارسال می‌کند. این شروع سریع درواقع نحوه ایجاد دو درخواست API را توضیح می‌دهد:

1. برای بازیابی اطلاعات مربوط به کانال YouTube‏ GoogleDevelopers، از کلید میانای برنامه‌سازی کاربردی استفاده خواهید کرد که برنامه شما را شناسایی می‌کند.
2. از شناسه کارخواه OAuth 2.0 برای ارسال درخواست مجاز استفاده خواهید کرد که اطلاعات مربوط به کانال YouTube خودتان را بازیابی می‌کند.

توجه: به‌طور کلی‌تر، می‌توانید دستورالعمل‌های مثال اول را برای هر مورد استفاده‌ای که از کلید API استفاده می‌کند، و دستورالعمل‌های مثال دوم را برای هر مورد استفاده‌ای که نیاز به مجوز بااستفاده از OAuth 2.0 دارد دنبال کنید. برای نمونه‌های بیشتر، ابزار موارد استفاده و نمونه‌های کد را ببینید.

پیش‌نیازها

برای اجرای این شروع سریع، به موارد زیر نیاز دارید:

• PHP 5.4 یا بالاتر با میانای خط فرمان (CLI) و افزونه JSON نصب‌شده.
• ابزار مدیریت وابستگی Composer به‌صورت سراسری نصب شد
• کتابخانه کارخواه Google APIs برای PHP:
  • اگر قبلاً کتابخانه مشتری را نصب نکرده‌اید:

    composer require google/apiclient:^2.0

  • اگر قبلاً کتابخانه مشتری را نصب کرده‌اید، توصیه می‌کنیم آن را به‌روز کنید تا مطمئن شوید جدیدترین کلاس‌ها را برای کتابخانه‌ای که آزمایش می‌کنید دارید:

    composer update google/apiclient --with-dependencies

مرحله ۱: راه‌اندازی پروژه و اطلاعات کاربری

پروژه‌ای را در کنسول Cloud ایجاد یا انتخاب کنید. تکالیف زیر را در Cloud Console برای پروژه‌تان تکمیل کنید:

1. در پانل کتابخانه، YouTube Data API v3 را جستجو کنید. روی فهرستگان آن میانای برنامه‌سازی کاربردی کلیک کنید و مطمئن شوید میانای برنامه‌سازی کاربردی برای پروژه‌تان فعال باشد.

2. در پانل اطلاعات کاربری، دو اطلاعات کاربری ایجاد کنید:

   1. ایجاد کلید میانای API از کلید میانای API برای ایجاد درخواست‌های میانای API که به مجوز کاربر نیاز ندارند استفاده خواهید کرد. برای مثال، برای بازیابی اطلاعات درباره یک کانال عمومی YouTube، نیازی به مجوز کاربر ندارید.

   2. ایجاد شناسه کارخواه OAuth 2.0 نوع برنامه را روی برنامه رایانه‌ای تنظیم کنید. برای درخواست‌هایی که به مجوز کاربر نیاز دارند، باید از اعتبارنامه‌های OAuth 2.0 استفاده کنید. برای مثال، برای بازیابی اطلاعات درباره کانال YouTube کاربر اصیل‌سازی‌شده فعلی، به مجوز کاربر نیاز دارید.

      فایل JSON حاوی اطلاعات کاربری OAuth 2.0 را بارگیری کنید. نام فایل باید شبیه client_secret_CLIENTID.json باشد، که در آن CLIENTID شناسه کاربر برای پروژه شما است.

مرحله ۲: راه‌اندازی و اجرای نمونه

از ابزارک APIs Explorer در پانل کناری برای دریافت کد نمونه برای بازیابی اطلاعات درباره کانال YouTube GoogleDevelopers استفاده کنید. این درخواست از کلید میانای برنامه‌سازی کاربردی برای شناسایی برنامه شما استفاده می‌کند و به مجوز کاربر یا هیچ اجازه خاصی ازسوی کاربری که نمونه را اجرا می‌کند نیاز ندارد.

1. مستندات مربوط به روش channels.list میانای برنامه‌سازی کاربردی را باز کنید.

2. در آن صفحه، بخش «موارد استفاده رایج» حاوی جدولی است که چندین روش رایج استفاده از این متد را توضیح می‌دهد. اولین فهرستگان در جدول برای فهرست کردن نتایج براساس شناسه کانال است.

   روی نماد کد برای فهرستگان اول کلیک کنید تا «کاوشگر API تمام‌صفحه» باز و تکمیل شود.

   

3. سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی تمام‌صفحه» موارد زیر را نشان می‌دهد:

   1. در زیر سرصفحه پارامترهای درخواست، فهرستی از پارامترهایی وجود دارد که روش پشتیبانی می‌کند. مقادیر پارامتر part و id باید تنظیم شود. مقدار پارامتر id، UC_x5XG1OV2P6uZZ5FSM9Ttw، شناسه کانال YouTube مربوط به GoogleDevelopers است.

   2. در زیر پارامترها، بخشی به‌نام اعتبارنامه‌ها وجود دارد. منوِ کرکره‌ای در آن بخش باید مقدار کلید میانای برنامه‌سازی کاربردی را نمایش دهد. APIs Explorer به‌طور پیش‌فرض از اعتبارنامه‌های نمایشی استفاده می‌کند تا شروع کار آسان‌تر شود. اما برای اجرای نمونه به‌صورت محلی، از کلید میانای برنامه‌سازی کاربردی خودتان استفاده خواهید کرد.

      

4. سمت راست «کاوشگر میاناهای برنامه‌سازی کاربردی» تمام‌صفحه، برگه‌هایی با نمونه‌های کد به زبان‌های مختلف نشان می‌دهد. برگه PHP را انتخاب کنید.

5. نمونه کد را کپی کنید و آن را در فایلی به‌نام example.php ذخیره کنید.

6. در نمونه‌ای که بارگیری کردید، رشته YOUR_API_KEY را پیدا کنید و آن را با کلید میانای برنامه‌سازی کاربردی که در مرحله ۱ این شروع سریع ایجاد کردید جایگزین کنید.

7. نمونه را از خط فرمان اجرا کنید. در دایرکتوری کاری‌تان، این دستور را اجرا کنید:

   php example.php

8. نمونه باید درخواست را اجرا کند و پاسخ را در STDOUT چاپ کند.

مرحله ۳: اجرای درخواست مجاز

در این مرحله، نمونه کدتان را اصلاح می‌کنید تا به‌جای بازیابی اطلاعات مربوط به کانال YouTube‏ GoogleDevelopers، اطلاعات مربوط به کانال YouTube شما را بازیابی کند. این درخواست به مجوز کاربر نیاز دارد.

1. به اسناد مربوط به روش channels.list میانای برنامه‌سازی کاربردی برگردید.

2. در بخش «موارد استفاده رایج»، روی نماد کد برای سومین فهرستگان در جدول کلیک کنید. این مورد استفاده برای فراخوانی روش list برای «کانال من» است.

3. دوباره در سمت چپ «کاوشگر میاناهای برنامه‌سازی کاربردی تمام‌صفحه»، فهرستی از پارامترها و سپس بخش اعتبارنامه‌ها را خواهید دید. بااین‌حال، دو تغییر نسبت‌به نمونه‌ای که اطلاعات مربوط به کانال GoogleDevelopers را بازیابی کردید وجود دارد:

   1. در بخش پارامترها، به‌جای اینکه مقدار پارامتر id تنظیم شود، مقدار پارامتر mine باید روی true تنظیم شود. این دستور به سرور API می‌گوید اطلاعات مربوط به کانال کاربر اصالت‌سنجی‌شده فعلی را بازیابی کند.

   2. در بخش اطلاعات کاربری، منوِ کرکره‌ای باید گزینه Google OAuth 2.0 را انتخاب کند.

      علاوه‌براین، اگر روی پیوند نمایش محدوده‌ها کلیک کنید، محدوده https://www.googleapis.com/auth/youtube.readonly باید علامت زده شود.

      

4. مانند مثال قبلی، برگه PHP را انتخاب کنید، نمونه کد را کپی کنید، و آن را در example.php ذخیره کنید.

   در کد، رشته YOUR_CLIENT_SECRET_FILE.json را پیدا کنید و آن را با مکان فایل رمز کارخواه که در مرحله ۱ این شروع سریع بارگیری کردید جایگزین کنید.

5. نمونه را از خط فرمان اجرا کنید. در دایرکتوری کاری‌تان، این را اجرا کنید:

   php example.php

6. نشانی وب را از کنسول کپی کنید و آن را در مرورگرتان باز کنید.

   اگر قبلاً به سیستم حساب Google خود وارد نشده باشید، از شما خواسته می‌شود به سیستم وارد شوید. اگر به سیستم چند حساب Google وارد شده باشید، از شما خواسته می‌شود یک حساب را برای استفاده در فرایند صدور مجوز انتخاب کنید.

7. روی دکمه کلیک کنید تا به برنامه‌تان اجازه دهید به دامنه‌های مشخص‌شده در نمونه کدتان دسترسی داشته باشد.

8. کد اصالت‌سنجی را از مرورگر کپی کنید و آن را در پایانه جای‌گذاری کنید. سپس می‌توانید برگه مرورگر استفاده‌شده برای جریان اصالت‌سنجی را ببندید.

   پاسخ میانای برنامه‌سازی کاربردی باید دوباره در STDOUT چاپ شود.

مطالعه بیشتر

• مستندات راهنمای Google Developers Console
• مستندات کتابخانه کارخواه میاناهای برنامه‌سازی کاربردی Google برای PHP
• کتابخانه کارخواه میاناهای برنامه‌سازی کاربردی Google برای PHP در GitHub و کلاس‌های تولیدشده خودکار برای YouTube API. (در صفحه، پوشه YouTube و فایل YouTube.php را پیدا کنید.
• اسناد مرجع YouTube Data API