הטמעה של אימות בצד השרת

צריך לאשר בקשות ל-Gmail API באמצעות פרטי כניסה של OAuth 2.0. צריך להשתמש בתהליך בצד השרת כשהאפליקציה צריכה לגשת לממשקי Google APIs מטעם המשתמש, למשל כשהמשתמש אופליין. הגישה הזו מחייבת העברה של קוד הרשאה חד-פעמי מהלקוח לשרת. הקוד הזה משמש לקבלת טוקן גישה וטוקני רענון לשרת.

למידע נוסף על הטמעת Google OAuth 2.0 בצד השרת, ראו שימוש ב-OAuth 2.0 לאפליקציות אינטרנט.

תוכן עניינים

יצירת מזהה לקוח וסוד לקוח

כדי להתחיל להשתמש ב-Gmail API, קודם צריך להשתמש בכלי ההגדרה. הכלי הזה מנחה אתכם בתהליך יצירת הפרויקט במסוף Google API, הפעלת ה-API ויצירת פרטי הכניסה.

1. בדף Credentials, לוחצים על Create credentials > OAuth client ID כדי ליצור את פרטי הכניסה ל-OAuth 2.0, או על Create credentials > Service account key כדי ליצור חשבון שירות.
2. אם יצרתם מזהה לקוח ב-OAuth, בוחרים את סוג האפליקציה.
3. ממלאים את הטופס ולוחצים על Create.

מזהי הלקוח ומפתחות חשבונות השירות של האפליקציה מופיעים עכשיו בדף Credentials. לפרטים, לוחצים על מזהה לקוח. הפרמטרים משתנים בהתאם לסוג המזהה, אבל יכולים לכלול כתובת אימייל, סוד לקוח, מקורות של JavaScript או כתובות URI להפניה אוטומטית.

חשוב לשים לב למספר הלקוח, כי תצטרכו להוסיף אותו לקוד מאוחר יותר.

טיפול בבקשות הרשאה

כשמשתמש טוען את האפליקציה בפעם הראשונה, מוצגת לו תיבת דו-שיח שבה הוא מתבקש להעניק לאפליקציה הרשאה לגשת לחשבון Gmail שלו עם היקפי ההרשאות המבוקשים. אחרי ההרשאה הראשונית, תיבת הדו-שיח של ההרשאה תוצג למשתמש רק אם מזהה הלקוח של האפליקציה ישתנה או אם ההיקפים המבוקשים ישתנו.

אימות המשתמש

הכניסה הראשונית הזו מחזירה אובייקט של תוצאת הרשאה שמכיל קוד הרשאה, אם היא מצליחה.

המרת קוד האימות באסימון גישה

קוד ההרשאה הוא קוד חד-פעמי שהשרת יכול להמיר באסימון גישה. אסימון הגישה הזה מועבר ל-Gmail API כדי להעניק לאפליקציה גישה לנתוני המשתמשים למשך זמן מוגבל.

אם האפליקציה שלכם דורשת גישה ל-offline, בפעם הראשונה שהאפליקציה מחליפה את קוד ההרשאה, היא מקבלת גם אסימון רענון שמשמש אותה לקבלת אסימון גישה חדש אחרי שתוקף האסימון הקודם פג. האפליקציה שומרת את אסימון הרענון הזה (בדרך כלל במסד נתונים בשרת) לשימוש מאוחר יותר.

חשוב: תמיד צריך לאחסן אסימוני רענון של משתמשים. אם האפליקציה שלכם זקוקה לאסימון רענון חדש, היא צריכה לשלוח בקשה עם פרמטר השאילתה approval_prompt שמוגדר כ-force. הפעולה הזו תגרום להצגת תיבת דו-שיח למשתמש, שבה הוא יצטרך להעניק שוב הרשאה לאפליקציה.

דוגמאות הקוד הבאות מדגימות החלפה של קוד הרשאה באסימון גישה עם הרשאת 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 ולשלוח בקשות ל-API.

יצירה של אובייקט שירות

בדוגמת הקוד הזו מוסבר איך ליצור אובייקט שירות ולאחר מכן להעניק לו הרשאה לשלוח בקשות API.

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 מתועדות במאמר העזרה בנושא 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, תוכלו להתחיל לטפל בהודעות, בשרשור ובתוויות, כפי שמתואר בקטעים של מדריכי המפתחים.

מידע נוסף על שיטות ה-API הזמינות זמין בהפניית ה-API.

אזהרה: כשבודקים את האפליקציה במהלך הפיתוח, חשוב להשתמש בחשבון Gmail לבדיקה שאין לכם חשיבות לנתונים שלו. כך תוכלו למנוע פגיעה לא מכוונת באימיילים, בשרשור ובתוויות שלכם.