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

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

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

תוכן עניינים

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

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

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

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

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

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

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

אימות המשתמש

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

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

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

אם לאפליקציה שלך נדרשת גישה ל-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.

פעולות נוספות בממשק API של 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()

השלבים הבאים

כשתהיו מוכנים לאשר בקשות API של Gmail, תוכלו להתחיל להתחיל לטפל בהודעות, בשרשורים ובתוויות, כפי שמתואר הקטע 'מדריכים למפתחים'.

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

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