經銷商適用的 Python 快速入門導覽課程

只要按照本快速入門指南中的步驟操作，約 10 分鐘內，您就能擁有一個簡單的 Python 指令列應用程式，用於向零接觸註冊經銷商 API 提出要求。

必要條件

如要執行這個快速入門，您需要：

  • Google 帳戶 (屬於零接觸註冊機制經銷商帳戶的成員)。如果尚未完成新手上路流程，請按照經銷商入口網站指南中的入門步驟操作。
  • Python 2.6 以上版本。
  • pip 套件管理工具。
  • 連上網際網路和網路瀏覽器。

步驟 1：啟用零接觸註冊 API

  1. 使用這個精靈，在 Google Developers Console 中建立或選取專案，並自動開啟 API。按一下「繼續」，然後點選「前往憑證」。
  2. 將「您需要存取什麼資料？」設為「應用程式資料」。
  3. 按一下「繼續」，系統應會提示您建立服務帳戶。
  4. 在「Service account name」(服務帳戶名稱) 中輸入描述性名稱。
  5. 請記下服務帳戶 ID (看起來像電子郵件地址)，因為您稍後會用到這個 ID。
  6. 將「角色」設為 [服務帳戶] > [服務帳戶使用者]。
  7. 按一下「Done」(完成)，即完成建立服務帳戶。
  8. 按一下您建立的服務帳戶電子郵件地址。
  9. 按一下「鍵」。
  10. 依序按一下「新增金鑰」和「建立新的金鑰」。
  11. 在「金鑰類型」中選取「JSON」。
  12. 按一下「Create」，私密金鑰就會下載到電腦中。
  13. 按一下「關閉」。
  14. 將檔案移至工作目錄，並重新命名為 service_account_key.json。
  1. 開啟零接觸註冊機制入口網站。您可能需要登入。
  2. 按一下「服務帳戶」圖示 。
  3. 按一下 「連結服務帳戶」。
  4. 將「電子郵件地址」設為您建立的服務帳戶地址。
  5. 按一下「連結服務帳戶」，即可使用服務帳戶和零接觸註冊帳戶。

步驟 3：安裝 Google 用戶端程式庫

執行下列指令，使用 pip 安裝程式庫：

pip install --upgrade google-api-python-client

如要瞭解其他安裝選項，請參閱程式庫的安裝頁面。

步驟 4：設定範例

在工作目錄中建立名為 quickstart.py 的檔案。複製下列程式碼並儲存檔案。插入您自己的經銷商合作夥伴 ID，做為 PARTNER_ID 的值 (應用程式匯入後的第一行)。

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Zero-touch enrollment reseller quickstart.

This script forms the quickstart introduction to the zero-touch enrollemnt
reseller API. To learn more, visit https://developer.google.com/zero-touch
"""

from apiclient.discovery import build
from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials

# TODO: replace this with your partner reseller ID.
PARTNER_ID = '11036885';

# A single auth scope is used for the zero-touch enrollment customer API.
SCOPES = ['https://www.googleapis.com/auth/androidworkprovisioning']
SERVICE_ACCOUNT_KEY_FILE = 'service_account_key.json'

def get_credential():
  """Creates a Credential object with the correct OAuth2 authorization.

  Creates a Credential object with the correct OAuth2 authorization
  for the service account that calls the reseller API. The service
  endpoint calls this method when setting up a new service instance.

  Returns:
    Credential, the user's credential.
  """
  credential = ServiceAccountCredentials.from_json_keyfile_name(
      SERVICE_ACCOUNT_KEY_FILE, scopes=SCOPES)
  return credential


def get_service():
  """Creates a service endpoint for the zero-touch enrollment reseller API.

  Builds and returns an authorized API client service for v1 of the API. Use
  the service endpoint to call the API methods.

  Returns:
    A service Resource object with methods for interacting with the service.
  """
  http_auth = get_credential().authorize(Http())
  service = build('androiddeviceprovisioning', 'v1', http=http_auth)
  return service


def main():
  """Runs the zero-touch enrollment quickstart app.
  """
  # Create a zero-touch enrollment API service endpoint.
  service = get_service()

  # Send an API request to list all our customers.
  response = service.partners().customers().list(partnerId=PARTNER_ID).execute()

  # Print out the details of each customer.
  if 'customers' in response:
    for customer in response['customers']:
      print 'Name:{0}  ID:{1}'.format(
          customer['companyName'], customer['companyId'])
  else:
    print 'No customers found'


if __name__ == '__main__':
  main()

合作夥伴 ID

API 呼叫通常需要您的經銷商合作夥伴 ID 做為引數。如要在零接觸註冊機制入口網站中查看合作夥伴 ID，請按照下列步驟操作：

  1. 開啟入口網站，您可能需要登入。
  2. 按一下 「Service Accounts」。
  3. 複製「你的經銷商 ID」行中的合作夥伴 ID 編號。

步驟 5：執行範例

利用作業系統的相關說明，執行檔案中的指令碼。在 UNIX 和 Mac 電腦上，請在終端機中執行下列指令：

python quickstart.py

列印 API 回應

如要更輕鬆地在試用 API 時檢查回應，請設定 JSON 回應資料的格式。下列程式碼片段說明如何在 Python 中使用 JSON 模組執行此操作：

from json import dumps

# ...

results = provisioning.partners().devices().claimAsync(partnerId=MY_PARTNER_ID,
 body={'claims':new_claims}).execute()
# Print formatted JSON response
print dumps(results, indent=4, sort_keys=True)

疑難排解

透過快速入門導覽課程告訴我們問題所在，我們會加以修正。如想瞭解零接觸機制如何使用服務帳戶授權 API 呼叫，請參閱「授權」。

瞭解詳情