دليل التشغيل السريع لـ Node.js

إنشاء تطبيق سطر أوامر Node.js يرسل طلبات إلى Reseller API

توضّح أدلة التشغيل السريع كيفية إعداد تطبيق وتشغيله لاستدعاء واجهة برمجة تطبيقات Google Workspace. يستخدم دليل التشغيل السريع هذا طريقة مصادقة مبسطة مناسبة لبيئة الاختبار. بالنسبة إلى بيئة الإنتاج، ننصحك بالتعرّف على المصادقة والتخويل قبل اختيار بيانات الاعتماد المناسبة لتطبيقك.

يستخدم دليل التشغيل السريع هذا مكتبات عملاء واجهة برمجة التطبيقات المقترَحة من Google Workspace للتعامل مع بعض تفاصيل عملية المصادقة والتخويل.

الأهداف

  • إعداد البيئة
  • تثبيت مكتبة البرامج
  • إعداد النموذج
  • تشغيل النموذج

المتطلبات الأساسية

لتشغيل دليل التشغيل السريع هذا، يجب استيفاء المتطلبات الأساسية التالية:

  • نطاق مورّد Google
  • اتفاقية شريك Google Workspace منفّذة بالكامل

إعداد البيئة

لإكمال دليل التشغيل السريع هذا، عليك إعداد البيئة.

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

قبل استخدام واجهات برمجة التطبيقات من Google، عليك تفعيلها في مشروع على Google Cloud. يمكنك تفعيل واجهة برمجة تطبيق واحدة أو أكثر في مشروع واحد على Google Cloud.

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

  1. في Google API Console، انتقِل إلى "القائمة" > منصة Google للمصادقة > العلامة التجارية.

    الانتقال إلى العلامة التجارية

  2. إذا سبق لك إعداد منصة Google للمصادقة، يمكنك إعداد إعدادات شاشة موافقة OAuth التالية في العلامة التجارية والجمهور والوصول إلى البيانات. إذا ظهرت لك رسالة لم يتم إعداد منصة Google للمصادقة بعد، انقر على البدء:
    1. ضمن معلومات التطبيق، في اسم التطبيق، أدخِل اسمًا للتطبيق.
    2. في البريد الإلكتروني لدعم المستخدمين، اختَر عنوان بريد إلكتروني للدعم يمكن للمستخدمين التواصل معك من خلاله إذا كانت لديهم أسئلة حول موافقتهم.
    3. انقر على التالي.
    4. ضمن الجمهور، اختَر داخلي.
    5. انقر على التالي.
    6. ضمن معلومات الاتصال، أدخِل عنوان بريد إلكتروني يمكنك تلقّي إشعارات من خلاله بشأن أي تغييرات تطرأ على مشروعك.
    7. انقر على التالي.
    8. ضمن إنهاء، راجِع سياسة بيانات المستخدمين في خدمات Google API، وإذا كنت موافقًا عليها، ضَع علامة في المربّع أوافق على سياسة بيانات المستخدمين في خدمات Google API.
    9. انقر على متابعة.
    10. انقر على إنشاء.
  3. يمكنك في الوقت الحالي تخطّي إضافة النطاقات. في المستقبل، عند إنشاء تطبيق لاستخدامه خارج مؤسسة Google Workspace، عليك تغيير نوع المستخدم إلى خارجي. بعد ذلك، أضِف نطاقات التخويل التي يتطلبها تطبيقك. لمزيد من المعلومات، اطّلِع على دليل إعداد موافقة OAuth الكامل Configure OAuth consent.

السماح ببيانات اعتماد لتطبيق على الكمبيوتر

لمصادقة المستخدمين النهائيين والوصول إلى بيانات المستخدمين في تطبيقك، عليك إنشاء معرّف عميل واحد أو أكثر لبروتوكول OAuth 2.0. يُستخدم معرّف العميل لتحديد تطبيق واحد لخوادم OAuth من Google. إذا كان تطبيقك يعمل على منصات متعددة، عليك إنشاء معرّف عميل منفصل لكل منصة.
  1. في Google Cloud Console، انتقِل إلى "القائمة" > منصة Google للمصادقة > العملاء.

    الانتقال إلى العملاء

  2. انقر على إنشاء عميل.
  3. انقر على نوع التطبيق > تطبيق على الكمبيوتر.
  4. في حقل الاسم ، اكتب اسمًا لبيانات الاعتماد. لا يظهر هذا الاسم إلا في Google Cloud Console.
  5. انقر على إنشاء.

    تظهر بيانات الاعتماد التي تم إنشاؤها حديثًا ضمن "معرّفات عملاء OAuth 2.0".

  6. احفظ ملف JSON الذي تم تنزيله باسم credentials.json وانقِل الملف إلى دليل العمل.

تثبيت مكتبة البرامج

  • ثبِّت المكتبات باستخدام npm:

    npm install googleapis@105 @google-cloud/local-auth@2.1.0 --save

إعداد النموذج

  1. في دليل العمل، أنشِئ ملفًا باسم index.js.

  2. في الملف، ألصِق الرمز البرمجي التالي:

    adminSDK/reseller/index.js
    import path from 'node:path';
import process from 'node:process';
import {authenticate} from '@google-cloud/local-auth';
import {google} from 'googleapis';

// The scope for the Admin SDK Reseller API.
const SCOPES = ['https://www.googleapis.com/auth/apps.order'];
// The path to the credentials file.
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Lists the first 10 subscriptions you manage.
 */
async function listSubscriptions() {
  // Authenticate with Google and get an authorized client.
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  // Create a new Admin SDK Reseller API client.
  const service = google.reseller({version: 'v1', auth});
  // Get the list of subscriptions.
  const result = await service.subscriptions.list({
    maxResults: 10,
  });
  const subscriptions = result.data.subscriptions;
  if (!subscriptions || subscriptions.length === 0) {
    console.log('No subscriptions found.');
    return;
  }

  // Print the customer ID, SKU ID, and plan name of each subscription.
  console.log('Subscriptions:');
  subscriptions.forEach(({customerId, skuId, plan}) => {
    console.log(`${customerId} (${skuId}, ${plan?.planName})`);
  });
}

await listSubscriptions();

تشغيل النموذج

  1. في دليل العمل، شغِّل النموذج:

    node .
  1. في المرة الأولى التي تشغِّل فيها النموذج، سيُطلب منك السماح بالوصول:
    1. إذا لم يسبق لك تسجيل الدخول إلى حسابك على Google، سجِّل الدخول عندما يُطلب منك ذلك. إذا كنت مسجِّلاً الدخول إلى حسابات متعددة، اختَر حسابًا واحدًا لاستخدامه في التخويل.
    2. انقر على حسنًا.

    يتم تشغيل تطبيق Nodejs ويستدعي Reseller API.

    يتم تخزين معلومات التخويل في نظام الملفات، لذا لن يُطلب منك منح الإذن في المرة التالية التي تشغِّل فيها نموذج الرمز البرمجي.

الخطوات التالية