توضح Quickstarts كيفية إعداد وتشغيل تطبيق يستدعي واجهة برمجة تطبيقات Google Workspace.
تستخدم عمليات التشغيل السريع في Google Workspace مكتبات برامج واجهة برمجة التطبيقات لمعالجة بعض تفاصيل عملية المصادقة والتفويض. ونوصي باستخدام مكتبات المكتبات لتطبيقاتك الخاصة. قبل أن تتمكن من تشغيل نموذج التطبيق، يتطلب كل بدء سريع تشغيل المصادقة والتفويض. إذا لم تكن على دراية بالمصادقة والتفويض لواجهات برمجة تطبيقات Google Workspace، يُرجى قراءة نظرة عامة على المصادقة والتفويض.
أنشئ تطبيق ويب جافا سكريبت يقدم طلبات إلى واجهة برمجة تطبيقات Gmail.
الأهداف
- إعداد البيئة.
- إعداد النموذج.
- شغّل النموذج.
المتطلبات الأساسية
- Python 2.4 or more لتشغيل خادم الويب.
- مشروع Google Cloud
- حساب Google تم فيه تفعيل Gmail.
إعداد البيئة
لإكمال عملية البدء السريع هذه، عليك إعداد البيئة.
تفعيل واجهة برمجة التطبيقات
قبل استخدام Google APIs، عليك تفعيلها في مشروع على Google Cloud. يمكنك تفعيل واجهة برمجة تطبيقات واحدة أو أكثر في مشروع Google Cloud واحد.في Google Cloud Console، فعِّل واجهة برمجة تطبيقات Gmail.
تفويض بيانات الاعتماد لتطبيق ويب
للمصادقة كمستخدم نهائي والوصول إلى بيانات المستخدم في تطبيقك، يجب إنشاء واحد أو أكثر من معرّفات عملاء OAuth 2.0. يتم استخدام معرِّف عميل لتحديد تطبيق واحد إلى خوادم OAuth في Google. إذا كان تطبيقك يعمل على أنظمة أساسية متعددة، يجب عليك إنشاء معرِّف عميل منفصل لكل نظام أساسي.- في وحدة تحكُّم Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.
- انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth.
- انقر على نوع التطبيق > تطبيق ويب.
- في حقل الاسم، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
- أضِف معرِّفات الموارد المنتظمة (URI) المعتمدة ذات الصلة بتطبيقك:
- التطبيقات من جانب العميل (JavaScript): ضمن مصادر JavaScript المعتمَدة، انقر على إضافة URI. ثم أدخل معرف الموارد المنتظم (URI) لاستخدامه لطلبات المتصفح. يحدد هذا الإعداد النطاقات التي يمكن لتطبيقك إرسال طلبات واجهة برمجة التطبيقات منها إلى خادم OAuth 2.0.
- تطبيقات من جانب الخادم (Java، وPython، وغير ذلك)–ضمن عناوين URL لإعادة التوجيه المُعتمَدة، انقر على إضافة URI. بعد ذلك، أدخِل معرّف الموارد المنتظم (URI) لنقطة النهاية الذي يمكن لخادم OAuth 2.0 إرسال الردود إليه.
- انقر على إنشاء. تظهر شاشة عميل OAuth الذي تم إنشاؤه وتعرض معرِّف العميل الجديد وسر العميل.
سجِّل معرِّف العميل. لا يتم استخدام أسرار العميل لتطبيقات الويب.
- انقر على حسنًا. تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن معرّفات عميل OAuth 2.0.
- اختياري: إذا كنت تنشئ بيانات اعتماد باعتبارها متطلبًا أساسيًا لبدء التشغيل السريع في JavaScript، عليك أيضًا إنشاء مفتاح واجهة برمجة تطبيقات.
دوِّن بيانات الاعتماد هذه لأنك تحتاج إليها لاحقًا في هذا البدء السريع.
إعداد النموذج
- في دليل العمل، أنشئ ملفًا باسم
index.html
. في ملف
index.html
، الصق نموذج الرمز التالي:استبدل ما يلي:
YOUR_CLIENT_ID
: معرِّف العميل الذي أنشأته عند اعتماد بيانات الاعتماد لتطبيق ويب.YOUR_API_KEY
: مفتاح واجهة برمجة التطبيقات الذي أنشأته كـ متطلب أساسي.
تشغيل النموذج
في دليل العمل، ابدأ خادم ويب:
Python 2.x
python -m SimpleHTTPServer 8000
Python
python3 -m http.server 8000
في متصفّحك، انتقِل إلى
http://localhost:8000
.عند تشغيل النموذج لأول مرة، سيطلب منك تفويض الوصول:
- إذا لم تكن قد سجلت الدخول إلى حسابك في Google من قبل، فسيُطلب منك تسجيل الدخول. إذا كنت قد سجلت الدخول إلى حسابات متعددة، فحدد حسابًا واحدًا لاستخدامه للتفويض.
- انقر على قبول.
- انسخ الرمز من المتصفح، والصقه في موجه سطر الأوامر،
واضغط على
Enter
.
يتم تخزين معلومات التفويض في نظام الملفات، لذا في المرة التالية التي يتم فيها تشغيل نموذج الشفرة، لن تتم مطالبتك بالتفويض.
لقد نجحت في إنشاء أول تطبيق جافا سكريبت يرسل طلبات إلى Gmail API.
الخطوات التالية
- تحديد مشاكل المصادقة والتفويض وحلّها
- المستندات المرجعية لواجهة برمجة تطبيقات Gmail
- قسم
google-api-javascript-client
في GitHub