As solicitações para a API Gmail precisam ser autorizadas usando credenciais do OAuth 2.0. Use o fluxo do lado do servidor quando o aplicativo precisa acessar as APIs do Google em nome do usuário, por exemplo, quando o usuário está off-line. Essa abordagem exige a transmissão de um código de autorização único do cliente para o servidor. Esse código é usado para adquirir um token de acesso e atualizar tokens para o servidor.
Para saber mais sobre a implementação do OAuth 2.0 do Google no servidor, consulte Usar o OAuth 2.0 para aplicativos de servidor da Web.
Conteúdo
Criar um ID e uma chave secreta do cliente
Para começar a usar a API Gmail, primeiro use a ferramenta de configuração, que oferece orientações sobre como criar um projeto no Console de APIs do Google, ativar a API e criar credenciais.
- Na página "Credenciais", clique em Criar credenciais > ID do cliente OAuth para criar suas credenciais do OAuth 2.0 ou Criar credenciais > Chave da conta de serviço para criar uma conta de serviço.
- Se você criou um ID do cliente OAuth, então selecione seu tipo de aplicativo.
- Preencha o formulário e clique em Criar.
Os IDs do cliente e as chaves da conta de serviço do aplicativo agora serão exibidas na página "Credenciais". Para saber mais, clique em um ID do cliente. Os parâmetros variam dependendo do tipo de ID, mas podem incluir endereço de e-mail, chave secreta do cliente, origens de JavaScript ou URIs de redirecionamento.
Anote o ID do cliente, porque você vai precisar adicioná-lo ao código mais tarde.
Como processar solicitações de autorização
Quando um usuário carrega seu aplicativo pela primeira vez, uma caixa de diálogo é mostrada para conceder permissão ao aplicativo para acessar a conta do Gmail com os escopos de permissão solicitados. Após essa autorização inicial, a caixa de diálogo de permissão só será mostrada ao usuário se o ID do cliente do app ou os escopos solicitados forem alterados.
Autenticação do usuário
Esse login inicial retorna um objeto de resultado de autorização que contém um código de autorização, se bem-sucedido.
Trocar o código de autorização por um token de acesso
O código de autorização é um código único que o servidor pode trocar por um token de acesso. Esse token de acesso é transmitido à API Gmail para conceder acesso do seu aplicativo aos dados do usuário por um período limitado.
Se o aplicativo exigir acesso offline, na primeira vez que ele trocar
o código de autorização, ele também receberá um token de atualização que será usado para
receber um novo token de acesso depois que o anterior expirar. Seu app
armazena esse token de atualização (geralmente em um banco de dados no servidor) para
uso posterior.
Os exemplos de código abaixo demonstram a troca de um código de autorização por
um token de acesso com acesso offline e o armazenamento do token de atualização.
Python
Substitua o valor CLIENTSECRETS_LOCATION pelo local do
arquivo 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)
Autorização com credenciais armazenadas
Quando os usuários acessam seu app após um fluxo de autorização bem-sucedido, o aplicativo pode usar um token de atualização armazenado para autorizar solicitações sem pedir ao usuário novamente.
Se você já tiver autenticado o usuário, seu app poderá recuperar o token de atualização do banco de dados e armazenar o token em uma sessão do lado do servidor. Se o token de atualização for revogado ou inválido, você precisará detectar isso e tomar as medidas adequadas.
Como usar credenciais do OAuth 2.0
Depois que as credenciais do OAuth 2.0 forem recuperadas, como mostrado na seção anterior, elas poderão ser usadas para autorizar um objeto de serviço do Gmail e enviar solicitações para a API.
Instanciar um objeto de serviço
Este exemplo de código mostra como instanciar um objeto de serviço e autorizá-lo a fazer solicitações de 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)
Enviar solicitações autorizadas e verificar credenciais revogadas
O snippet de código a seguir usa uma instância de serviço do Gmail autorizada para extrair uma lista de mensagens.
Se ocorrer um erro, o código vai verificar um código de status HTTP 401,
que precisa ser processado redirecionando o usuário para o URL
de autorização.
Mais operações da API Gmail estão documentadas na Referência da 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()
Próximas etapas
Quando você estiver confortável para autorizar solicitações da API Gmail, poderá começar a processar mensagens, linhas de conversa e marcadores, conforme descrito nas seções dos guias para desenvolvedores.
Saiba mais sobre os métodos de API disponíveis na Referência da API.