媒体应用程序接口（Publisher APIs） – Symphony支持

什么是媒体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
}