Dokumentation Adobe Pass Adobe Pass-autentisering

Hämta lista över förauktoriserade resurser retrieve-list-of-preauthorized-resources

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Autentisering

NOTE

Innehållet på den här sidan tillhandahålls endast i informationssyfte. Användning av denna API kräver en aktuell licens från Adobe. Ingen obehörig användning är tillåten.

NOTE

REST API-implementeringen begränsas av Begränsningsmekanismen

REST API-slutpunkter clientless-endpoints

<REGGIE_FQDN>:

Produktion - api.auth.adobe.com
Mellanlagring - api.auth-staging.adobe.com

<SP_FQDN>:

Produktion - api.auth.adobe.com
Mellanlagring - api.auth-staging.adobe.com

Beskrivning description

En begäran till Adobe Pass Authentication om att få en lista över förauktoriserade resurser.

Det finns två uppsättningar API en uppsättning för Streaming App eller Programmer Service och en uppsättning för Second Screen Web App. Den här sidan beskriver API:t för Streaming App eller Programmer Service.

Slutpunkt

Anropat
av

Indata
Parametrar

HTTP
Metod

Svar

HTTP
Response

<SP_FQDN>/api/v1/förauktorisera

Direktuppspelande app

eller

Programmeringtjänst

1. beställare (obligatoriskt)
2. deviceId (obligatoriskt)
3. resurslista (obligatoriskt)
4. device_info/X-Device-Info (obligatoriskt)
5. deviceType
6. deviceUser (utgått)
7. appId (inaktuellt)

GET

XML eller JSON som innehåller individuella beslut före auktorisering eller felinformation. Se exemplen nedan.

200 - Lyckades

400 - Felaktig begäran

401 - Obehörig

405 - Metoden tillåts inte

412 - Förhandsvillkoret misslyckades

500 - Internt serverfel

Indataparameter

Beskrivning

begärande

Programmerarens requestId som den här åtgärden är giltig för.

deviceId

Byte för enhets-ID.

resurslista

En sträng som innehåller en kommaavgränsad lista med resourceIds som identifierar det innehåll som kan vara tillgängligt för en användare och som känns igen av MVPD-auktoriseringsslutpunkter.

device_info/

X-Device-Info

Information om direktuppspelningsenhet.

Obs!: Detta kan skickas som device_info som URL-parameter, men på grund av parameterns potentiella storlek och begränsningar i längden på en GET-URL, bör det skickas som X-Device-Info i http-huvudet.

Mer information finns i Skicka information om enheter och anslutningar.

deviceType

Enhetstypen (till exempel Roku, PC).

Om den här parametern är korrekt har ESM värden som är nedbrutna per enhetstyp när klientlösa används, så att olika typer av analyser kan utföras, till exempel Roku, AppleTV och Xbox.

Se fördelarna med att använda en enhetstypparameter utan klient i pass-mått

Obs! device_info ersätter den här parametern.

deviceUser

Enhetens användaridentifierare.

appId

Program-ID/namn.

Obs!: device_info ersätter den här parametern.

Exempelsvar sample-response

XML:

HTTP/1.1 200 OK
Adobe-Request-Id : 7af28ec2-a068-45c2-8009-f5443049baf4
Adobe-Response-Confidence : full
Content-Type: application/xml; charset=utf-8

<resources>
  <resource>
    <id>TestStream1</id>
    <authorized>true</authorized>
  </resource>
  <resource>
    <id>TestStream2</id>
    <authorized>false</authorized>
    <error>
      <status>403</status>
      <code>authorization_denied_by_mvpd</code>
      <message>User not authorized</message>
      <details>Your subscription package does not include the "TestStream3" channel.</details>
      <helpUrl>https://experienceleague-review.corp.adobe.com/docs/primetime/authentication/auth-features/error-reportn/enhanced-error-codes.html#error-codes</helpUrl>
      <trace>0453f8c8-167a-4429-8784-cd32cfeaee58</trace>
      <action>none</action>
    </error>
  </resource>
</resources>

JSON:

HTTP/1.1 200 OK
Adobe-Request-Id : 7af28ec2-a068-45c2-8009-f5443049baf4
Adobe-Response-Confidence : full
Content-Type: application/json; charset=utf-8

{
   "resources" : [
        {
            "id" : "TestStream1",
            "authorized" : true
        },
        {
            "id" : "TestStream3",
            "authorized" : false,
            "error" : {
               "status" : 403,
               "code" : "authorization_denied_by_mvpd",
               "message" : "User not authorized",
               "details" : "Your subscription package does not include the "TestStream3" channel.",
               "helpUrl" : "https://experienceleague-review.corp.adobe.com/docs/primetime/authentication/auth-features/error-reportn/enhanced-error-codes.html#error-codes",
               "trace" : "0453f8c8-167a-4429-8784-cd32cfeaee58",
               "action" : "none"
            }
        }
    ]
}

recommendation-more-help

3f5e655c-af63-48cc-9769-2b6803cc5f4b