什麼是媒體API
訂閱Symphony的媒體(Subscribe Publisher)現在可以通過應用程序接口(API)與Symphony進行交互。
訂閱媒體在Symphony中開通授權后, 媒體用戶可以得到廣告訂單媒體信息和廣告訂單中的下單金額。通過Symphony Swagger文檔可以訪問到API詳細信息。
如果訂閱媒體需要得到API權限,請聯繫客戶服務團隊。
請注意:
- 媒體只能使用適當的憑據訪問到媒體API
- 代理公司不能使用媒體APIs
訂閱媒體可以在擁有客戶密鑰和密碼後進行身份驗證,以便與我們的身份驗證API一起使用,並接受允許他們使用所有新創建的斷電的令牌。
媒體可以通過以下端點註冊已發佈廣告訂單和已簽署廣告訂單的通知:
/applications/{applicationId}/subscriptions
媒體能夠通過Symphony API檢索到該廣告訂單的數據和成本:
/campaigns/{campaignId}/RFPInsertionOrders/publisher/{IONumber}
/campaigns/{campaignId}/RFPInsertionOrders/publisher/{IONumber}/{IOVersion}/costItems
從Symphony中檢索過去的通知
訂閱媒體在Symphony中註冊通知后,媒體和代理商能夠根據各種過濾條件檢索過去的所有通知:
- 通知的日期和時間範圍
- 郵件是否已發送
- 通知類型 (廣告訂單已發出,廣告訂單已簽署, 自定義費用, 廣告活動已創建, 廣告活動已批准)
- 響應代碼:/applications/{applicationId}/subscriptions/notificationHistory
請注意:我們只通過API響應返回1000,如果響應超過該數量,用戶將不得不進一步過濾條件
Symphony應用程序接口現在可以讓用戶訂閱不同事件的通知信息。當出現被訂閱的事件,Symphony將推送被訂閱的事件至回調網址。此回調網址的POST將是在郵件正文中傳遞的通知對象。不同事件類型有不同的通知,但是他們都包含以下5個共同屬性:
- 事件名稱(EventName)
- 密鑰(Secret)
- 代理ID(AgencyBranchUniqueId)
- 組織ID(OrganisationUniqueId)
- 活動ID(CampaignUniqueId)
如需管理訂閱,請參考以下操作:
調取:/applications/{applicationId}/subscriptions
推送:/applications/{applicationId}/subscriptions
通知對象:
- 發送廣告訂單
{
EventName: IOIssued,
Secret: 123456789abcdefghijklmnopqrstu,
AgencyBranchUniqueId: 00000000-0000-0000-0000-000000000000
OrganisationUniqueId: 98CB4154-B8B9-4D6C-9762-069C069FC665,
CampaignUniqueId: D12AB414-2ECC-476A-BAAD-403170342AEB,
IONumber: 1-12-1,
IOVersion: 1,
Version: 1
}
- 簽署廣告訂單
{
EventName: IOSignedOff,
Secret: 123456789abcdefghijklmnopqrstu,
AgencyBranchUniqueId: 00000000-0000-0000-0000-000000000000
OrganisationUniqueId: 98CB4154-B8B9-4D6C-9762-069C069FC665,
CampaignUniqueId: D12AB414-2ECC-476A-BAAD-403170342AEB,
IONumber: 1-12-1,
IOVersion: 1,
Version: 1
}
評論
0 條評論
請登入寫評論。