بدء استخدام مكتبة عملاء PHP

لبدء استخدام واجهة برمجة التطبيقات لمكتبة "صور Google" مع مكتبة برامج لغة PHP، عليك إعداد مكتبة البرامج في بيئة التطوير. قبل إجراء ذلك، يجب ضبط مشروعك من خلال تفعيل واجهة برمجة التطبيقات عبر وحدة التحكم في واجهة Google API وإعداد معرِّف عميل OAuth 2.0.

يتفاعل تطبيقك مع "صور Google" نيابةً عن مستخدم من مستخدمي "صور Google". على سبيل المثال، عند إنشاء ألبومات في مكتبة مستخدم صور Google أو تحميل عناصر وسائط إلى حساب مستخدم على "صور Google"، يسمح المستخدم لطلبات واجهة برمجة التطبيقات هذه عبر بروتوكول OAuth 2.0.

يتيح معرِّف عميل OAuth 2.0 لمستخدمي تطبيقك تسجيل الدخول والمصادقة، وبالتالي استخدام Library API. لا تتيح واجهة برمجة التطبيقات Library API استخدام حسابات الخدمة، ولاستخدام واجهة برمجة التطبيقات هذه، على المستخدمين تسجيل الدخول إلى حساب Google صالح.

ضبط إعدادات تطبيقك

تفعيل واجهة برمجة التطبيقات

يجب تفعيل واجهة برمجة التطبيقات Library API في مشروعك قبل أن تتمكّن من استخدامها.

  1. انتقِل إلى وحدة التحكم في واجهة Google API.
  2. من شريط القوائم، اختَر مشروعًا أو أنشِئ مشروعًا جديدًا.
  3. لفتح مكتبة Google API، اختَر واجهات برمجة التطبيقات والخدمات > المكتبة من قائمة التنقّل.
  4. ابحث عن "Google Photos Library API". اختَر النتيجة الصحيحة وانقر على تفعيل.

طلب معرِّف عميل OAuth 2.0

اتّبِع الخطوات أدناه لطلب معرِّف عميل OAuth وإعداده لتطبيقك. يستخدم هذا المثال تطبيقًا يتم فيه معالجة تدفق OAuth بالكامل من جهة الخادم، مثل التطبيق الموجود في نماذجنا. قد تختلف عملية الإعداد بالنسبة إلى سيناريوهات التنفيذ الأخرى.

  1. انتقِل إلى وحدة التحكم في واجهة Google API واختَر مشروعك.
  2. من القائمة، اختر APIs & Services (واجهات برمجة التطبيقات والخدمات) > Credentials (بيانات الاعتماد).
  3. في صفحة بيانات الاعتماد، انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
  4. اختَر نوع التطبيق. في هذا المثال، نوع التطبيق هو تطبيق الويب.

  5. سجّل المصادر التي تم السماح لتطبيقك من خلالها بالوصول إلى Google APIs على النحو التالي:

    1. لتحديد معرِّف العميل، أدخِل اسمًا.

    2. في الحقل مصادر JavaScript المسموح بها، أدخِل أصل تطبيقك. لا يسمح هذا الحقل بأحرف البدل.

      يمكنك إدخال مصادر متعددة للسماح بتشغيل تطبيقك على بروتوكولات أو نطاقات أو نطاقات فرعية مختلفة. يُسمح لعناوين URL التي تُدخلها ببدء طلب OAuth.

      يعرض المثال التالي عنوان URL للتطوير المحلي (تستخدم نماذجنا localhost:8080) وعنوان URL للإنتاج.

      http://localhost:8080
https://myproductionurl.example.com

    3. حقل معرّف الموارد المنتظم (URI) لإعادة التوجيه المعتمد هو نقطة النهاية التي تتلقى الردود من خادم OAuth 2.0. عادةً ما يتضمن ذلك بيئة التطوير الخاصة بك ويشير إلى مسار في تطبيقك.

      http://localhost:8080/auth/google/callback
https://myproductionurl.example.com/auth/google/callback

    4. انقر على إنشاء.

  1. من مربع حوار عميل OAuth الناتج، نزِّل ملف JSON الذي يحتوي على إعدادات العميل. تتألف تفاصيل العميل مما يلي:

    • معرِّف العميل
    • سر العميل

    سيتم استخدام ملف JSON هذا لاحقًا لإعداد مكتبة مصادقة Google للغة PHP التي تتوافق مع مكتبة البرامج هذه.

قبل أن تتمكّن من إطلاق تطبيق عام يمكنه الوصول إلى واجهة برمجة تطبيقات Library (واجهة برمجة تطبيقات المكتبة)، يجب أن تُراجع Google تطبيقك. تظهر الرسالة "لم يتم التحقق من التطبيق" على الشاشة عند اختبار التطبيق، حتى يتم التحقق منه.

إعداد مكتبة العملاء

تتعامل مكتبة برامج لغة PHP مع جميع طلبات البيانات من واجهة برمجة التطبيقات الخلفية نيابةً عنك، وتعرض العناصر السهلة الاستخدام، بما في ذلك نماذج التعليمات البرمجية لبعض المهام الشائعة لواجهة برمجة التطبيقات. أولاً، عليك تنزيل وتثبيت مكتبة برامج واجهة برمجة التطبيقات لمكتبة صور Google للغة PHP مع التبعيات من GitHub. بعد ذلك، يجب إعداد بيانات اعتماد OAuth2 للغة PHP.

خيارات التنزيل

استخدِم composer لتضمين المكتبة باعتبارها تبعية في بيئة التطوير. شغِّل الأمر التالي لإضافة المكتبة إلى إعدادات المشروع، ثم نزِّلها إلى دليل vendor/.

composer require google/photos-library

وبدلاً من ذلك، يمكنك أيضًا استنساخ المستودع أو تنزيل لعبة tarball مضغوطة.

إعداد بيانات اعتماد OAuth2 للغة PHP

تعمل مكتبة البرامج هذه مع مكتبة مصادقة Google للغة PHP. ولمزيد من المعلومات، يُرجى الرجوع إلى استخدام OAuth 2.0 مع مكتبة برامج Google API للغة PHP.

استخدِم بيانات اعتماد المصادقة التي تعرضها مكتبة المصادقة عند إعداد PhotosLibraryClient.

تجربة بعض النماذج

جرِّب الرمز أدناه لإجراء أول طلب بيانات من واجهة برمجة التطبيقات باستخدام مكتبة برامج PHP.

use Google\Auth\Credentials\UserRefreshCredentials;
use Google\Photos\Library\V1\PhotosLibraryClient;
use Google\Photos\Library\V1\PhotosLibraryResourceFactory;

try {
    // Use the OAuth flow provided by the Google API Client Auth library
    // to authenticate users. See the file /src/common/common.php in the samples for a complete
    // authentication example.
    $authCredentials = new UserRefreshCredentials( /* Add your scope, client secret and refresh token here */ );

    // Set up the Photos Library Client that interacts with the API
    $photosLibraryClient = new PhotosLibraryClient(['credentials' => $authCredentials]);

    // Create a new Album object with at title
    $newAlbum = PhotosLibraryResourceFactory::album("My Album");

    // Make the call to the Library API to create the new album
    $createdAlbum = $photosLibraryClient->createAlbum($newAlbum);

    // The creation call returns the ID of the new album
    $albumId = $createdAlbum->getId();
} catch (\Google\ApiCore\ApiException $exception) {
    // Error during album creation
} catch (\Google\ApiCore\ValidationException $e) {
    // Error during client creation
    echo $exception;
}

هناك المزيد من النماذج على GitHub يمكنك تجربتها.