Route Optimization API 支援使用 OAuth 2.0 進行驗證。Google 支援常見的 OAuth 2.0 使用情境,例如網路伺服器的這類使用情境。
本文件說明如何在開發環境環境中將 OAuth 權杖傳送至 Route Optimization API 呼叫。如需在實際工作環境環境中使用 OAuth 的操作說明,請參閱「Google 的驗證」。
事前準備
您必須擁有已連結帳單帳戶的專案,並啟用 Route Optimization API,才能開始使用 Route Optimization API。建議您建立多個專案擁有者和帳單管理員,這樣您的團隊隨時都有擔任這些角色的成員可處理相關事務。請參閱這篇文章,進一步瞭解如何在 Cloud 控制台中完成相關設定。
關於 OAuth
根據您的部署環境,使用 OAuth 建立及管理存取權杖的方法有很多種。
舉例來說,Google OAuth 2.0 系統支援伺服器對伺服器的互動,例如應用程式和 Google 服務之間的互動。在這種情況下,您需要一個屬於應用程式的帳戶,而非個別使用者的帳戶。應用程式會代表服務帳戶呼叫 Google API,因此使用者不會直接參與。如要進一步瞭解驗證方法,請參閱「Google 的驗證」一文。
或者,您也可以在 Android 或 iOS 行動應用程式中使用 Route Optimization API。如需將 OAuth 與 Route Optimization API 搭配使用的一般資訊,包括如何管理不同部署環境的存取權杖的資訊,請參閱使用 OAuth 2.0 存取 Google API。
關於 OAuth 範圍
如要搭配 Route Optimization API 使用 OAuth,必須將 OAuth 權杖指派給範圍:
https://www.googleapis.com/auth/cloud-platform
範例:在本機開發環境中嘗試 REST API 呼叫
如果您想使用 OAuth 權杖試用 Route Optimization API,但並未設定產生權杖的環境,可以透過本節的程序來呼叫。
這個範例說明如何使用應用程式預設憑證 (ADC) 提供的 OAuth 憑證發出呼叫。如要瞭解如何使用 ADC 透過用戶端程式庫呼叫 Google API,請參閱「使用用戶端程式庫進行驗證」。
必要條件
使用 ADC 提出 REST 要求之前,請使用 Google Cloud CLI 為 ADC 提供憑證:
- 如果您尚未建立專案,並按照「在 Google Cloud 控制台進行設定」一文中的步驟,建立專案並啟用計費功能。
- 安裝並初始化 gcloud CLI。
在本機電腦上執行下列
gcloud
指令,建立憑證檔案:gcloud auth application-default login
- 系統隨即會顯示登入畫面。登入後,您的憑證會儲存於 ADC 使用的本機憑證檔案。
詳情請參閱「為應用程式預設憑證提供憑證」說明文件中的「本機開發環境」一節。
發出 REST 要求
在這個範例中,您要傳送兩個要求標頭:
使用下列指令產生權杖,在
Authorization
標頭中傳遞 OAuth 權杖:gcloud auth application-default print-access-token
傳回的權杖範圍是
https://www.googleapis.com/auth/cloud-platform.
- 將要求主體內容類型指定為
application/json
。
以下範例使用 OAuth 權杖呼叫 Route Optimization API:
curl -X POST 'https://routeoptimization.googleapis.com/v1/projects/PROJECT_NUMBER_OR_ID:optimizeTours' \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ --data-binary @- << EOM { "model": { "shipments": [ { "pickups": [ { "arrivalLocation": { "latitude": 37.73881799999999, "longitude": -122.4161 } } ], "deliveries": [ { "arrivalLocation": { "latitude": 37.79581, "longitude": -122.4218856 } } ] } ], "vehicles": [ { "startLocation": { "latitude": 37.73881799999999, "longitude": -122.4161 }, "endLocation": { "latitude": 37.73881799999999, "longitude": -122.4161 } } ], "globalStartTime": "2023-01-13T16:00:00-08:00", "globalEndTime": "2023-01-14T16:00:00-08:00" } } EOM
疑難排解
如果您的要求傳回錯誤訊息,指出此 API 不支援使用者憑證,請參閱使用者憑證無法運作一文。