本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
步驟 2:設定 Postman
您已經建立了能夠存取 Amazon Pinpoint API 的用戶,現在就來設定 Postman。在本節中,您將在 Postman 中建立一或多個環境。接著匯入一個集合,將 Amazon Pinpoint API 中每個操作的請求範本包含在內。
在 Postman 中,工作空間是專案和環境的組織容器。本節中,您需要建立至少一個工作空間,與 Amazon Pinpoint 搭配使用。
建立工作區
在 Postman 中,依序選擇更多動作、檔案,然後選擇新增。
-
在新建視窗中,選擇工作空間。
輸入名稱、摘要,並將可見性設為個人。然後選擇建立工作空間。
在 Postman 中,環境是儲存為鍵值組形式的一組變數。使用環境即可變更您透過 Postman 提出的請求的組態,不須變更 API 請求本身。
本節中,您需要建立至少一個環境,與 Amazon Pinpoint 搭配使用。您建立的每個環境,在單一 AWS 區域中包含一組您帳戶專用的變數。若使用本節程序建立多個環境,可從 Postman的環境功能表選擇不同的環境,在區域之間變更。
建立環境
-
在 Postman 中,選擇更多動作功能表,選擇檔案,然後選擇新增。
-
在 Create New (建立新項目) 視窗中,選擇 Environment (環境)。
-
在 MANAGE ENVIRONMENTS (管理環境) 視窗中,對於 Environment Name (環境名稱),輸入
Amazon Pinpoint -
。將Region Name
Region Name (區域名稱)
替換為下列其中一個值:-
美國東部 (維吉尼亞北部)
-
美國西部 (奧勒岡)
-
亞太區域 (孟買)
-
亞太區域 (悉尼)
-
歐洲 (法蘭克福)
-
歐洲 (愛爾蘭)
注意
您至少只需要為一個單一的環境建立一個環境 AWS 區域,而且 AWS 區域 必須包含一個專案。如果您尚未在先前列出的其中一個專案中建立專案 AWS 區域,請參閱 Amazon Pinpoint 使用者指南中的使用電子郵件支援建立 Amazon Pinpoint 專案。
-
-
建立六個新變數:
endpoint
、region
、serviceName
、accountId
、accessKey
和secretAccessKey
。使用下表,判斷要在每個變數的初始值和目前值欄位中輸入哪個值。區域 變數 初始值和目前值 美國東部 (維吉尼亞北部) endpoint
pinpoint.us-east-1.amazonaws.com
region
us-east-1
serviceName
mobiletargeting
accountId
(您的 AWS 帳戶 ID) accessKey
(您的 IAM 存取金鑰 ID) secretAccessKey
(您的 IAM 私密存取金鑰) 美國西部 (奧勒岡) endpoint
pinpoint.us-west-2.amazonaws.com
region
us-west-2
serviceName
mobiletargeting
accountId
(您的 AWS 帳戶 ID) accessKey
(您的 IAM 存取金鑰 ID) secretAccessKey
(您的 IAM 私密存取金鑰) 亞太區域 (孟買) endpoint
pinpoint.ap-south-1.amazonaws.com
region
ap-south-1
serviceName
mobiletargeting
accountId
(您的 AWS 帳戶 ID) accessKey
(您的 IAM 存取金鑰 ID) secretAccessKey
(您的 IAM 私密存取金鑰) 亞太區域 (悉尼) endpoint
pinpoint.ap-southeast-2.amazonaws.com
region
ap-southeast-2
serviceName
mobiletargeting
accountId
(您的 AWS 帳戶 ID) accessKey
(您的 IAM 存取金鑰 ID) secretAccessKey
(您的 IAM 私密存取金鑰) 歐洲 (法蘭克福) endpoint
pinpoint.eu-central-1.amazonaws.com
region
eu-central-1
serviceName
mobiletargeting
accountId
(您的 AWS 帳戶 ID) accessKey
(您的 IAM 存取金鑰 ID) secretAccessKey
(您的 IAM 私密存取金鑰) 歐洲 (愛爾蘭) endpoint
pinpoint.eu-west-1.amazonaws.com
region
eu-west-1
serviceName
mobiletargeting
accountId
(您的 AWS 帳戶 ID) accessKey
(您的 IAM 存取金鑰 ID) secretAccessKey
(您的 IAM 私密存取金鑰) 建立這些變數後,MANAGE ENVIRONMENTS (管理環境) 視窗會類似於下圖所示的範例。
完成後,請選擇儲存。
重要
上圖中的存取金鑰是虛構的。請勿與他人共用您的 IAM 存取金鑰。
Postman 包含的功能,可讓您分享和匯出環境。如果使用這些功能,請不要與任何無權存取這些憑證的人員分享您的存取金鑰 ID 和私密存取金鑰。
如需詳細資訊,請參閱《IAM 使用者指南》中的 IAM 最佳實務。
-
(選用) 針對您要建立的每個其他環境,重複步驟 1 – 4。
提示
在 Postman 中,您可以建立任意數量的環境。您可以透過以下方法使用環境:
-
針對您必須測試 Amazon Pinpoint API 的每個區域,個別建立環境。
-
建立與不同 AWS 帳戶相關聯的環境。
-
建立使用了與其他使用者相關聯的憑證的環境。
-
-
當您完成建立環境,請移至下一節。
在 Postman 中,集合是一組 API 請求。集合中的請求通常由共同目標結合在一起。本節中,您需要在 Amazon Pinpoint API 中建立一個新集合,並包含每個操作的請求範本。
若要建立 Amazon Pinpoint 集合
-
在 Postman 中,選擇更多動作功能表,選擇檔案,然後選擇匯入。
-
在「匯入」視窗中,選擇「從連結匯入」,然後輸入下列網址:https://raw.githubusercontent.com/awsdocs/ amazon-pinpoint-developer-guide /主/亞馬
遜 %20 選擇匯入。Postman 會匯入 Amazon Pinpoint 集合,該集合包含 120 個範例請求。
匯入 Amazon Pinpoint 集合後,建議您執行快速測試,確認所有元件均已正確設定。您可以透過提交 GetApps
請求來測試您的組態。此請求會針對目前 AWS 區域中,您 Amazon Pinpoint 帳戶裡所有的專案,傳回一份清單。此請求不需要額外的組態,因此是測試組態的好方法。
若要測試 Amazon Pinpoint 集合的組態
-
在左側導覽面板中,選取集合,展開 Amazon Pinpoint 集合,然後展開應用程式資料夾。
-
在要求清單中,選擇GetApps。
-
使用環境選取器來選擇您在建立郵遞員環境中建立的環境。
-
選擇傳送。如果請求成功傳送,回應窗格會顯示
200 OK
的狀態。您會看到類似下圖範例的回應。注意
如果你沒有在 AWS 區域 那麼 Amazon Pinpoint 返回
{ "Item": [] }
創建任何項目。這個回應針對您在步驟 3 選擇的區域,列出帳戶中所有存在的 Amazon Pinpoint 專案。
故障診斷
當您提交請求時,可能會看到錯誤。請參閱以下清單,了解您可能會遇到的數個常見錯誤,以及您可以採取以解決問題的步驟。
錯誤訊息 | 問題 | 解析度 |
---|---|---|
|
|
使用環境選擇器來選擇環境。 |
|
Postman 找不到您存取金鑰 ID 或私密存取金鑰的目前值。 |
請選擇環境選擇器旁邊的齒輪圖示,然後選擇目前的環境。確認 |
|
與您使用者相關聯的 IAM 政策,未包含適當的許可。 |
確認您的使用者具有建立 IAM 政策中所述的許可,並且您在建立 Postman 工作區中建立環境時提供了正確的登入資料。 |
下一步:傳送其他請求