بدء سريع

يمكنكم إنشاء تطبيق سطر أوامر بلغة Go يرسل طلبات إلى Reseller API.

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

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

الأهداف

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

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

• أحدث إصدار من لغة Go.
• أحدث إصدار من Git.
• مشروع على Google Cloud.

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

إعداد البيئة

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

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

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

• في Google Cloud Console، فعِّلوا Reseller API.

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

إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth

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

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

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

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

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

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

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

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

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

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

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

إعداد مساحة العمل

1. أنشئوا دليل عمل:

   mkdir quickstart
   

2. انتقِلوا إلى دليل العمل:

   cd quickstart
   

3. ابدأوا الوحدة الجديدة:

   go mod init quickstart
   

4. احصلوا على مكتبة عميل Go لـ Reseller API وحزمة OAuth2.0:

   go get google.golang.org/api/reseller/v1
   go get golang.org/x/oauth2/google
   

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

1. في دليل العمل، أنشئوا ملفًا باسم quickstart.go.

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

   admin_sdk/reseller/quickstart.go

   عرض على GitHub
   package main
   
   import (
   	"context"
   	"encoding/json"
   	"fmt"
   	"log"
   	"net/http"
   	"os"
   
   	"golang.org/x/oauth2"
   	"golang.org/x/oauth2/google"
   	"google.golang.org/api/option"
   	"google.golang.org/api/reseller/v1"
   )
   
   // Retrieve a token, saves the token, then returns the generated client.
   func getClient(config *oauth2.Config) *http.Client {
   	// The file token.json stores the user's access and refresh tokens, and is
   	// created automatically when the authorization flow completes for the first
   	// time.
   	tokFile := "token.json"
   	tok, err := tokenFromFile(tokFile)
   	if err != nil {
   		tok = getTokenFromWeb(config)
   		saveToken(tokFile, tok)
   	}
   	return config.Client(context.Background(), tok)
   }
   
   // Request a token from the web, then returns the retrieved token.
   func getTokenFromWeb(config *oauth2.Config) *oauth2.Token {
   	authURL := config.AuthCodeURL("state-token", oauth2.AccessTypeOffline)
   	fmt.Printf("Go to the following link in your browser then type the "+
   		"authorization code: \n%v\n", authURL)
   
   	var authCode string
   	if _, err := fmt.Scan(&authCode); err != nil {
   		log.Fatalf("Unable to read authorization code: %v", err)
   	}
   
   	tok, err := config.Exchange(context.TODO(), authCode)
   	if err != nil {
   		log.Fatalf("Unable to retrieve token from web: %v", err)
   	}
   	return tok
   }
   
   // Retrieves a token from a local file.
   func tokenFromFile(file string) (*oauth2.Token, error) {
   	f, err := os.Open(file)
   	if err != nil {
   		return nil, err
   	}
   	defer f.Close()
   	tok := &oauth2.Token{}
   	err = json.NewDecoder(f).Decode(tok)
   	return tok, err
   }
   
   // Saves a token to a file path.
   func saveToken(path string, token *oauth2.Token) {
   	fmt.Printf("Saving credential file to: %s\n", path)
   	f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
   	if err != nil {
   		log.Fatalf("Unable to cache oauth token: %v", err)
   	}
   	defer f.Close()
   	json.NewEncoder(f).Encode(token)
   }
   
   func main() {
   	ctx := context.Background()
   	b, err := os.ReadFile("credentials.json")
   	if err != nil {
   		log.Fatalf("Unable to read client secret file: %v", err)
   	}
   
   	// If modifying these scopes, delete your previously saved token.json.
   	config, err := google.ConfigFromJSON(b, reseller.AppsOrderScope)
   	if err != nil {
   		log.Fatalf("Unable to parse client secret file to config: %v", err)
   	}
   	client := getClient(config)
   
   	srv, err := reseller.NewService(ctx, option.WithHTTPClient(client))
   	if err != nil {
   		log.Fatalf("Unable to retrieve reseller Client %v", err)
   	}
   
   	r, err := srv.Subscriptions.List().MaxResults(10).Do()
   	if err != nil {
   		log.Fatalf("Unable to retrieve subscriptions. %v", err)
   	}
   
   	if len(r.Subscriptions) == 0 {
   		fmt.Println("No subscriptions found.")
   	} else {
   		fmt.Println("Subscriptions:")
   		for _, s := range r.Subscriptions {
   			fmt.Printf("%s (%s, %s)\n", s.CustomerId, s.SkuId, s.Plan.PlanName)
   		}
   	}
   }

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

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

   go run quickstart.go
   

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

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

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

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

• جرِّبوا واجهات برمجة التطبيقات في Google Workspace في مستكشف واجهات برمجة التطبيقات
  • درس تطبيقي حول الترميز لواجهة برمجة تطبيقات Google Workspace Reseller API
  • المستندات المرجعية لواجهة برمجة التطبيقات لموزّعي Google Workspace
  • google-api-go-client قسم على GitHub