Wdróż autoryzację po stronie serwera

Żądania do interfejsu Gmail API muszą być autoryzowane za pomocą danych logowania OAuth 2.0. Użyj przepływu po stronie serwera, gdy aplikacja potrzebuje dostępu do interfejsów API Google w imieniu użytkownika, np. gdy użytkownik jest offline. To podejście wymaga przekazania na serwer kodu autoryzacji jednorazowego z klienta. Kod ten służy do uzyskiwania tokenów dostępu i tokenów odświeżania na serwerze.

Więcej informacji o implementacji protokołu OAuth 2.0 Google po stronie serwera znajdziesz w artykule Używanie OAuth 2.0 w internetowych aplikacjach serwerowych.

Spis treści

Tworzenie identyfikatora i tajnego klucza klienta

Aby rozpocząć korzystanie z interfejsu Gmail API, musisz najpierw użyć narzędzia do konfiguracji, które przeprowadzi Cię przez proces tworzenia projektu w konsoli interfejsów API Google, włączania interfejsu API i tworzenia danych logowania.

1. Na stronie Dane logowania kliknij Utwórz dane logowania > Identyfikator klienta OAuth, aby utworzyć dane logowania OAuth 2.0, lub Utwórz dane logowania > Klucz konta usługi, aby utworzyć konto usługi.
2. Jeśli masz już utworzony identyfikator klienta OAuth, wybierz typ aplikacji.
3. Wypełnij formularz i kliknij Utwórz.

Identyfikatory klienta i klucze konta usługi Twojej aplikacji są teraz widoczne na stronie Dane logowania. Aby uzyskać szczegółowe informacje, kliknij identyfikator klienta. Parametry różnią się w zależności od typu identyfikatora, ale mogą obejmować adres e-mail, klucz tajny klienta, źródła JavaScriptu lub identyfikatory URI przekierowania.

Zapisz identyfikator klienta, ponieważ będzie on potrzebny później do dodania do kodu.

Przetwarzanie próśb o autoryzację

Gdy użytkownik wczyta aplikację po raz pierwszy, zobaczy okno z prośbą o przyznanie aplikacji dostępu do jego konta Gmail w wymaganym zakresie. Po tej początkowej autoryzacji użytkownik zobaczy okno z prośbą o uprawnienia tylko wtedy, gdy zmieni się identyfikator klienta Twojej aplikacji lub zakresy wymaganych uprawnień.

Uwierzytelnienie użytkownika

Ta początkowa próba logowania zwraca obiekt wyniku autoryzacji, który zawiera kod autoryzacji, jeśli się powiedzie.

Wymiana kodu autoryzacji na token dostępu

Kod autoryzacji to kod jednorazowy, który serwer może wymienić na token dostępu. Ten token dostępu jest przekazywany do interfejsu Gmail API, aby umożliwić aplikacji dostęp do danych użytkownika przez ograniczony czas.

Jeśli aplikacja wymaga dostępu offline, podczas pierwszej wymiany kodu autoryzacji otrzymuje też token odświeżania, którego używa do otrzymywania nowego tokena dostępu po wygaśnięciu poprzedniego. Aplikacja przechowuje ten token odświeżania (zwykle w bazie danych na serwerze) na później.

Ważne: zawsze przechowuj tokeny odświeżania użytkownika. Jeśli Twoja aplikacja potrzebuje nowego tokena odświeżania, musi wysłać żądanie z parametrem zapytania approval_prompt ustawionym na force. Użytkownik zobaczy okno z prośbą o ponowne przyznanie uprawnień aplikacji.

Poniższe przykłady kodu pokazują, jak zamienić kod autoryzacji na token dostępu z dostępem offline i zapisać token odświeżania.

Python

Zastąp wartość CLIENTSECRETS_LOCATION lokalizacją pliku 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)

Autoryzacja za pomocą zapisanych danych logowania

Gdy użytkownicy odwiedzają Twoją aplikację po pierwszym udanym przeprowadzeniu procesu autoryzacji, aplikacja może użyć zapisanego tokena odświeżania, aby autoryzować żądania bez ponownego wyświetlania prośby o potwierdzenie.

Jeśli uwierzytelnienie użytkownika zostało już przeprowadzone, aplikacja może pobrać token odświeżania z bazy danych i przechowywać go w sesji po stronie serwera. Jeśli token odświeżania został cofnięty lub jest nieprawidłowy, musisz to wykryć i podjąć odpowiednie działania.

Korzystanie z danych logowania OAuth 2.0

Po pobraniu danych logowania OAuth 2.0 w sposób opisany w poprzedniej sekcji możesz ich użyć do autoryzacji obiektu usługi Gmail i wysyłania żądań do interfejsu API.

Tworzenie instancji obiektu usługi

Ten przykładowy kod pokazuje, jak utworzyć instancję obiektu usługi, a następnie autoryzować go do wysyłania żądań do interfejsu 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)

Wysyłanie autoryzowanych żądań i sprawdzanie, czy dane logowania nie zostały cofnięte

Podany niżej fragment kodu używa autoryzowanego wystąpienia usługi Gmail do pobrania listy wiadomości.

Jeśli wystąpi błąd, kod sprawdza kod stanu HTTP 401, który powinien być obsługiwany przez przekierowanie użytkownika do adresu URL autoryzacji.

Więcej operacji interfejsu Gmail API znajdziesz w dokumentacji 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()

Dalsze kroki

Gdy już zatwierdzisz autoryzację żądań interfejsu API Gmaila, możesz zacząć obsługiwać wiadomości, wątki i etykiety zgodnie z opisem w sekcjach przewodników dla deweloperów.

Więcej informacji o dostępnych metodach interfejsu API znajdziesz w dokumentacji interfejsu API.

Ostrzeżenie: podczas testowania aplikacji w trakcie tworzenia użyj testowego konta Gmail, na którym nie zależy Ci szczególnie. Zapobiegnie to przypadkowemu usunięciu e-maili, wątków i etykiet.