يجب الموافقة على الطلبات إلى واجهة برمجة تطبيقات Gmail باستخدام بيانات اعتماد OAuth 2.0. يجب عليك استخدام التدفق من جانب الخادم عندما يحتاج تطبيقك إلى الوصول إلى Google APIs بالنيابة عن المستخدم، على سبيل المثال، عندما يكون المستخدم غير متصل بالإنترنت. تتطلب هذه الطريقة تمرير رمز تفويض لمرة واحدة من العميل إلى الخادم، وتُستخدم هذه الكود للحصول على رمز دخول وإعادة تحميل الرموز المميزة لخادمك.
للحصول على مزيد من المعلومات حول تنفيذ Google OAuth 2.0 من جهة الخادم، يُرجى الاطّلاع على استخدام OAuth 2.0 لتطبيقات خادم الويب.
المحتويات
إنشاء معرِّف العميل وسر العميل
لبدء استخدام Gmail API، عليك أولاً استخدام أداة الإعداد التي ترشدك خلال إنشاء مشروع في وحدة التحكم في واجهة Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.
- من صفحة "بيانات الاعتماد"، انقر على إنشاء بيانات اعتماد > معرِّف عميل OAuth لإنشاء بيانات اعتماد OAuth 2.0 أو إنشاء بيانات اعتماد > مفتاح حساب الخدمة لإنشاء حساب خدمة.
- إذا أنشأت معرِّف عميل OAuth، اختَر نوع التطبيق.
- املأ النموذج وانقر على إنشاء.
يتم الآن إدراج معرِّفات العملاء ومفاتيح حساب الخدمة لتطبيقك في صفحة "بيانات الاعتماد". لمعرفة التفاصيل، انقر على معرّف العميل، علمًا بأنّ المَعلمات تختلف بناءً على نوع المعرّف، ولكنها قد تتضمّن عنوان البريد الإلكتروني أو سر العميل أو مصادر JavaScript أو معرّفات الموارد المنتظمة (URI) لإعادة التوجيه.
دوِّن معرِّف العميل لأنك ستحتاج إلى إضافته إلى الرمز في وقت لاحق.
معالجة طلبات التفويض
عندما يُحمِّل مستخدم تطبيقك لأول مرة، يظهر له مربّع حوار لمنح التطبيق إذنًا بالوصول إلى حسابه على Gmail من خلال نطاقات الأذونات المطلوبة. بعد هذا التفويض الأولي، لا يظهر للمستخدم مربع حوار الأذونات إلا إذا تغير معرف العميل للتطبيق أو تغيرت النطاقات المطلوبة.
مصادقة المستخدم
تعرض عملية تسجيل الدخول الأولية هذه كائن نتيجة التفويض الذي يحتوي على رمز تفويض في حال نجاحه.
تبادل رمز التفويض لرمز الدخول
رمز التفويض هو رمز يُستخدم لمرة واحدة يمكن لخادمك استبداله برمز دخول. يتم تمرير رمز الدخول هذا إلى واجهة برمجة تطبيقات Gmail لمنح تطبيقك إذن الوصول إلى بيانات المستخدمين لفترة محدودة.
إذا كان تطبيقك يتطلّب الوصول إلى offline، سيتلقّى التطبيق أيضًا رمزًا مميزًا لإعادة التحميل في أول مرة يتبادل فيها رمز التفويض، ويستخدمه لتلقّي رمز دخول جديد بعد انتهاء صلاحية رمز مميّز سابق. ويخزن تطبيقك رمز التحديث هذا (بشكل عام في قاعدة بيانات على الخادم) لاستخدامه لاحقًا.
توضّح نماذج الرموز التالية تبادل رمز التفويض لرمز وصول مع إمكانية الوصول إلى offline وتخزين الرمز المميز لإعادة التحميل.
لغة Python
استبدِل القيمة CLIENTSECRETS_LOCATION بموقع ملف client_secrets.json.
import logging
from oauth2client.client import flow_from_clientsecrets
from oauth2client.client import FlowExchangeError
from apiclient.discovery import build
# ...
# Path to client_secrets.json which should contain a JSON document such as:
# {
# "web": {
# "client_id": "[[YOUR_CLIENT_ID]]",
# "client_secret": "[[YOUR_CLIENT_SECRET]]",
# "redirect_uris": [],
# "auth_uri": "https://accounts.google.com/o/oauth2/auth",
# "token_uri": "https://accounts.google.com/o/oauth2/token"
# }
# }
CLIENTSECRETS_LOCATION = '<PATH/TO/CLIENT_SECRETS.JSON>'
REDIRECT_URI = '<YOUR_REGISTERED_REDIRECT_URI>'
SCOPES = [
'https://www.googleapis.com/auth/gmail.readonly',
'https://www.googleapis.com/auth/userinfo.email',
'https://www.googleapis.com/auth/userinfo.profile',
# Add other requested scopes.
]
class GetCredentialsException(Exception):
"""Error raised when an error occurred while retrieving credentials.
Attributes:
authorization_url: Authorization URL to redirect the user to in order to
request offline access.
"""
def __init__(self, authorization_url):
"""Construct a GetCredentialsException."""
self.authorization_url = authorization_url
class CodeExchangeException(GetCredentialsException):
"""Error raised when a code exchange has failed."""
class NoRefreshTokenException(GetCredentialsException):
"""Error raised when no refresh token has been found."""
class NoUserIdException(Exception):
"""Error raised when no user ID could be retrieved."""
def get_stored_credentials(user_id):
"""Retrieved stored credentials for the provided user ID.
Args:
user_id: User's ID.
Returns:
Stored oauth2client.client.OAuth2Credentials if found, None otherwise.
Raises:
NotImplemented: This function has not been implemented.
"""
# TODO: Implement this function to work with your database.
# To instantiate an OAuth2Credentials instance from a Json
# representation, use the oauth2client.client.Credentials.new_from_json
# class method.
raise NotImplementedError()
def store_credentials(user_id, credentials):
"""Store OAuth 2.0 credentials in the application's database.
This function stores the provided OAuth 2.0 credentials using the user ID as
key.
Args:
user_id: User's ID.
credentials: OAuth 2.0 credentials to store.
Raises:
NotImplemented: This function has not been implemented.
"""
# TODO: Implement this function to work with your database.
# To retrieve a Json representation of the credentials instance, call the
# credentials.to_json() method.
raise NotImplementedError()
def exchange_code(authorization_code):
"""Exchange an authorization code for OAuth 2.0 credentials.
Args:
authorization_code: Authorization code to exchange for OAuth 2.0
credentials.
Returns:
oauth2client.client.OAuth2Credentials instance.
Raises:
CodeExchangeException: an error occurred.
"""
flow = flow_from_clientsecrets(CLIENTSECRETS_LOCATION, ' '.join(SCOPES))
flow.redirect_uri = REDIRECT_URI
try:
credentials = flow.step2_exchange(authorization_code)
return credentials
except FlowExchangeError, error:
logging.error('An error occurred: %s', error)
raise CodeExchangeException(None)
def get_user_info(credentials):
"""Send a request to the UserInfo API to retrieve the user's information.
Args:
credentials: oauth2client.client.OAuth2Credentials instance to authorize the
request.
Returns:
User information as a dict.
"""
user_info_service = build(
serviceName='oauth2', version='v2',
http=credentials.authorize(httplib2.Http()))
user_info = None
try:
user_info = user_info_service.userinfo().get().execute()
except errors.HttpError, e:
logging.error('An error occurred: %s', e)
if user_info and user_info.get('id'):
return user_info
else:
raise NoUserIdException()
def get_authorization_url(email_address, state):
"""Retrieve the authorization URL.
Args:
email_address: User's e-mail address.
state: State for the authorization URL.
Returns:
Authorization URL to redirect the user to.
"""
flow = flow_from_clientsecrets(CLIENTSECRETS_LOCATION, ' '.join(SCOPES))
flow.params['access_type'] = 'offline'
flow.params['approval_prompt'] = 'force'
flow.params['user_id'] = email_address
flow.params['state'] = state
return flow.step1_get_authorize_url(REDIRECT_URI)
def get_credentials(authorization_code, state):
"""Retrieve credentials using the provided authorization code.
This function exchanges the authorization code for an access token and queries
the UserInfo API to retrieve the user's e-mail address.
If a refresh token has been retrieved along with an access token, it is stored
in the application database using the user's e-mail address as key.
If no refresh token has been retrieved, the function checks in the application
database for one and returns it if found or raises a NoRefreshTokenException
with the authorization URL to redirect the user to.
Args:
authorization_code: Authorization code to use to retrieve an access token.
state: State to set to the authorization URL in case of error.
Returns:
oauth2client.client.OAuth2Credentials instance containing an access and
refresh token.
Raises:
CodeExchangeError: Could not exchange the authorization code.
NoRefreshTokenException: No refresh token could be retrieved from the
available sources.
"""
email_address = ''
try:
credentials = exchange_code(authorization_code)
user_info = get_user_info(credentials)
email_address = user_info.get('email')
user_id = user_info.get('id')
if credentials.refresh_token is not None:
store_credentials(user_id, credentials)
return credentials
else:
credentials = get_stored_credentials(user_id)
if credentials and credentials.refresh_token is not None:
return credentials
except CodeExchangeException, error:
logging.error('An error occurred during code exchange.')
# Drive apps should try to retrieve the user and credentials for the current
# session.
# If none is available, redirect the user to the authorization URL.
error.authorization_url = get_authorization_url(email_address, state)
raise error
except NoUserIdException:
logging.error('No user ID could be retrieved.')
# No refresh token has been retrieved.
authorization_url = get_authorization_url(email_address, state)
raise NoRefreshTokenException(authorization_url)
المصادقة باستخدام بيانات الاعتماد المخزنة
عندما يزور المستخدمون تطبيقك بعد إجراء عملية ناجحة للتفويض لأول مرة، يمكن لتطبيقك استخدام الرمز المميَّز لإعادة التحميل مُخزَّنًا لمصادقة الطلبات بدون طلب ذلك من المستخدم مرة أخرى.
إذا سبق لك مصادقة المستخدم، يمكن لتطبيقك استرداد الرمز المميز لإعادة التحميل من قاعدة بياناته وتخزين الرمز في جلسة من جهة الخادم. إذا تم إبطال الرمز المميز لإعادة التحميل أو كان غير صالح، عليك اكتشاف هذا الخطأ واتخاذ الإجراء المناسب.
استخدام بيانات اعتماد OAuth 2.0
بعد استرداد بيانات اعتماد OAuth 2.0 كما هو موضّح في القسم السابق، يمكن استخدامها لاعتماد عنصر خدمة Gmail وإرسال الطلبات إلى واجهة برمجة التطبيقات.
إنشاء مثيل من عنصر خدمة
يوضّح نموذج الرمز هذا كيفية إنشاء مثيل لكائن خدمة ثم منحه إذنًا لإجراء طلبات من واجهة برمجة التطبيقات.
لغة Python
from apiclient.discovery import build
# ...
def build_service(credentials):
"""Build a Gmail service object.
Args:
credentials: OAuth 2.0 credentials.
Returns:
Gmail service object.
"""
http = httplib2.Http()
http = credentials.authorize(http)
return build('gmail', 'v1', http=http)
إرسال الطلبات المعتمَدة والتحقق من بيانات الاعتماد التي تم إبطالها
يستخدم مقتطف الرمز التالي مثيل خدمة Gmail معتمدًا لاسترداد قائمة الرسائل.
وفي حال حدوث خطأ، يتحقق الرمز من توفُّر رمز حالة HTTP 401،
والتي يجب معالجتها من خلال إعادة توجيه المستخدم إلى عنوان URL للتفويض.
يتم توثيق المزيد من عمليات واجهة برمجة التطبيقات Gmail API في مرجع واجهة برمجة التطبيقات.
لغة Python
from apiclient import errors
# ...
def ListMessages(service, user, query=''):
"""Gets a list of messages.
Args:
service: Authorized Gmail API service instance.
user: The email address of the account.
query: String used to filter messages returned.
Eg.- 'label:UNREAD' for unread Messages only.
Returns:
List of messages that match the criteria of the query. Note that the
returned list contains Message IDs, you must use get with the
appropriate id to get the details of a Message.
"""
try:
response = service.users().messages().list(userId=user, q=query).execute()
messages = response['messages']
while 'nextPageToken' in response:
page_token = response['nextPageToken']
response = service.users().messages().list(userId=user, q=query,
pageToken=page_token).execute()
messages.extend(response['messages'])
return messages
except errors.HttpError, error:
print 'An error occurred: %s' % error
if error.resp.status == 401:
# Credentials have been revoked.
# TODO: Redirect the user to the authorization URL.
raise NotImplementedError()
الخطوات التالية
عندما تشعر بالراحة عند تفويض طلبات واجهة برمجة التطبيقات Gmail API، تكون جاهزًا لبدء التعامل مع الرسائل وسلاسل المحادثات والتصنيفات، كما هو موضح في أقسام أدلة مطوّري البرامج.
يمكنك الاطّلاع على المزيد من المعلومات حول طرق واجهة برمجة التطبيقات المتاحة في مرجع واجهة برمجة التطبيقات.