
Salesforce元數(shù)據(jù)API開發(fā)指南
創(chuàng)建賬戶后,您需要登錄以訪問Postman的所有功能。登錄后,可以根據(jù)需要設置賬戶的安全性,例如選擇僅自己可見或團隊可用。
在Postman中,您可以創(chuàng)建Collection來組織和管理API的請求。可以選擇創(chuàng)建一個文件夾以便分類管理不同的請求。
在Salesforce中創(chuàng)建ConnectedApp是使用Postman進行API測試的前提。首先,導航到設置頁面,選擇應用程序并創(chuàng)建新的連接應用程序。
在創(chuàng)建ConnectedApp時,您需要填寫相關信息,包括名稱和回調地址。完成后,保存設置并等待幾分鐘以生成Client Id和Client Secret。
確保ConnectedApp的設置已正確保存,并記下生成的Client Id與Client Secret,這將在后續(xù)的AccessToken獲取中使用。
在Postman中,您可以通過OAuth2.0授權流程獲取AccessToken。創(chuàng)建請求后,選擇OAuth2.0類型進行授權,并點擊“Get New Access Token”按鈕。
根據(jù)Salesforce OAuth2.0的要求,配置請求的參數(shù)如Client Id、Client Secret以及回調地址。確保這些信息與之前創(chuàng)建的ConnectedApp一致。
完成上述步驟后,您將獲得一個AccessToken,可以在后續(xù)的API請求中使用它進行認證。
在調用Salesforce的標準REST API之前,您需要獲取系統(tǒng)的Domain信息。這可以通過在Salesforce設置中查找來實現(xiàn)。
在Postman中配置請求的Authorization,將之前獲取的AccessToken設置為Bearer Token,以便請求可以被正確認證。
配置好請求的URL和請求體后,發(fā)送請求以執(zhí)行標準的REST API操作,例如創(chuàng)建或更新記錄。請求體可以使用JSON格式來描述。
{
"Name": "New Account",
"Phone": "1234567890"
}
自定義REST API允許更靈活的操作。例如,可以通過Account ID獲取記錄。下面是一個簡單的Apex類示例:
@RestResource(urlMapping='/account/*')
global with sharing class AccountCreationService {
@HttpGet
global static Account doGet() {
RestRequest req = RestContext.request;
String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1);
Account result = [SELECT Id, Name, Phone FROM Account WHERE Id = :accountId];
return result;
}
}
同樣地,配置Postman中的請求,使用相同的Authorization設置。URL應指向自定義API的地址,其中包含類中聲明的urlMapping信息。
發(fā)送請求,并根據(jù)API的定義獲取相應的結果。確保請求的參數(shù)和路徑正確無誤。
Bulk API適用于處理大量數(shù)據(jù)操作。您可以通過POST請求創(chuàng)建Ingest Job以執(zhí)行批量刪除操作。
{
"operation": "hardDelete",
"object": "Account",
"contentType": "CSV",
"lineEnding": "CRLF"
}
為創(chuàng)建的Ingest Job上傳CSV文件。確保在Postman中選擇Body -> binary選項上傳文件。
通過PATCH請求通知Ingest Job上傳已完成,Job將開始工作并可以通過查詢其狀態(tài)來查看進度。
{
"state":"UploadComplete"
}
使用Bulk API時,CSV文件的上傳是關鍵步驟。確保文件格式正確,數(shù)據(jù)完整。
通過查詢Job狀態(tài)來監(jiān)控數(shù)據(jù)操作的進度,確保所有操作都能順利完成。
在處理大量數(shù)據(jù)時,可能會遇到錯誤或異常。檢查API的響應,并根據(jù)錯誤信息進行相應的調整。
總結,本篇文章詳細介紹了如何使用Postman配置和調用Salesforce API,包括標準和自定義REST API以及Bulk API的數(shù)據(jù)操作。通過這些步驟,您可以輕松地集成和測試Salesforce系統(tǒng)。