启动授权 initiate-authorization

NOTE
此页面上的内容仅供参考。 使用此API需要来自Adobe的当前许可证。 不允许未经授权使用。
NOTE
REST API实现受限制机制限制

REST API端点 clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

描述 description

获取授权响应。

端点
调用者
输入
参数
HTTP
方法
响应
HTTP
响应
<SP_FQDN>/api/v1/authorize
流式处理应用程序



程序员服务
1.请求者(必需)
2。 deviceId (必需)
3。 资源(必需)
4。 device_info/X-Device-Info (必需)
5。 deviceType
6。 deviceUser (已弃用)
7。 appId (已弃用)
8。 额外参数(可选)
GET
包含授权详细信息或错误详细信息(如果未成功)的XML或JSON。 请参阅下面的示例。
200 — 成功
403 — 无成功
输入参数
描述
请求者
此操作有效的程序员requestorId。
deviceId
设备ID字节。
资源
一个字符串,它包含resourceId(或MRSS片段),标识用户请求的内容并被MVPD授权端点识别。
设备信息/

X — 设备信息
流设备信息。

注意:可以将此device_info作为URL参数传递,但由于此参数的潜在大小以及GETURL的长度限制,它应作为X-Device-Info传递到http标头。

传递设备和连接信息中查看完整的详细信息。
deviceType
设备类型(例如Roku、PC)。

如果此参数设置正确,ESM提供的量度在使用无客户端程序时按设备类型🔗进行划分,因此可以对Roku、AppleTV、Xbox等执行不同类型的分析。

查看传递量度中无客户端设备类型参数的好处​

注意: device_info将替换此参数。
设备用户
设备用户标识符。
appId
应用程序id/名称。

注意: device_info将替换此参数。
额外参数
调用可能还包含可选参数,这些参数可启用其他功能,如:

* generic_data — 允许使用促销临时传递

示例: generic_data=("email":"email@domain.com")
CAUTION
流设备IP地址

对于客户端到服务器实施,流设备IP地址将随此调用隐式发送。 对于服务器到服务器实施,如果由程序员服务而不是流设备进行​ regcode ​调用,则需要以下标头来传递流设备IP地址:
code language-none
X-Forwarded-For : <streaming\_device\_ip>
其中<streaming\_device\_ip>是流设备公共IP地址。


示例:
code language-none
POST /reggie/v1/{req_id}/regcode HTTP/1.1
X-Forwarded-For:203.45.101.20

示例响应 sample-response

  • 用例1:成功

    • XML:

    ``XML
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <authorization>
    <expires>1348148289000</expires>
    <mvpd>sampleMvpdId</mvpd>
    <requestor>sampleRequestorId</requestor>
    <resource>sampleResourceId</resource>
    </authorization>
    `'

  • JSON:

    code language-json
    {
      "mvpd": "sampleMvpdId",
      "resource": "sampleResourceId",
      "requestor": "sampleRequestorId",
      "expires": "1348148289000"
    }
    
IMPORTANT
当响应来自代理MVPD时,它可能包含一个名为proxyMvpd的附加元素。
  • 案例2:授权被拒绝

    code language-json
    <error>
      <status>403</status>
      <message>User not authorized</message>
      <details>Your subscription package does not include the "ASFAFD" channel.
      Please go to http://www.ca.ble/upgrade in order to upgrade your subscription.</details>
    </error>
    
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b