Hämta förauktoriseringsbeslut med hjälp av en specifik mvpd retrieve-preauthorization-decisions-using-specific-mvpd

IMPORTANT
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.
IMPORTANT
REST API V2-implementeringen begränsas av dokumentationen för begränsningsmekanismen.

Begäran request

HTTP
bana
/api/v2/{serviceProvider}/Decision/preauthorized/{mvpd}
method
POST
Sökvägsparametrar
serviceProvider
Den interna unika identifierare som är associerad med tjänsteleverantören under introduktionsprocessen.
obligatoriskt
mvpd
Den interna unika identifierare som är associerad med identitetsleverantören under introduktionsprocessen.
obligatoriskt
Kroppsparametrar
resurser
Listan med resurser som kräver ett MVPD-beslut innan de kan visas.
obligatoriskt
Sidhuvuden
Behörighet
Genereringen av mottagarens tokennyttolast beskrivs i rubrikdokumentationen för autentisering.
obligatoriskt
Content-Type
Godkänd medietyp för resurserna som skickas.

Det måste vara application/json.
obligatoriskt
AP-Device-Identifier
Genereringen av nyttolasten för enhetsidentifieraren beskrivs i rubrikdokumentationen för AP-Device-Identifier.
obligatoriskt
X-Device-Info
Genereringen av nyttolasten för enhetsinformation beskrivs i rubrikdokumentationen för X-Device-Info.

Vi rekommenderar att du alltid använder den när programmets enhetsplattform tillåter explicit tillhandahållande av giltiga värden.

När detta anges sammanfogas Adobe Pass Authentication-backend explicit med extraherade värden implicit (som standard).

Om det inte anges kommer Adobe Pass Authentication-serverdelen att använda extraherade värden implicit (som standard).
obligatoriskt
X-Forwarded-For
Direktuppspelningsenhetens IP-adress.

Vi rekommenderar starkt att du alltid använder det för server-till-server-implementeringar, särskilt när anropet görs av programmeringstjänsten i stället för av direktuppspelningsenheten.

För implementeringar från klient till server skickas direktuppspelningsenhetens IP-adress implicit.
valfri
Adobe-Subject-Token
eller
X-Roku-Reserved-Roku-Connect-Token
Genereringen av nyttolasten för enkel inloggning för metoden Platform Identity beskrivs i rubrikdokumentationen för Adobe-Subject-Token / X-Roku-Reserved-Roku-Connect-Token.

Mer information om enkla inloggningsaktiverade flöden med en plattformsidentitet finns i dokumentationen för enkel inloggning med plattformsidentitetsflöden.
valfri
AD-Service-token
Genereringen av nyttolasten för enkel inloggning för Service Token-metoden beskrivs i rubrikdokumentationen för AD-Service-Token.

Mer information om enkla inloggningsaktiverade flöden med en tjänsttoken finns i dokumentationen för enkel inloggning med tjänsttoken flows.
valfri
AP-Partner-Framework-status
Genereringen av nyttolasten för enkel inloggning för partnermetoden beskrivs i rubrikdokumentationen för AP-Partner-Framework-Status .

Mer information om aktiverade flöden för enkel inloggning med en partner finns i dokumentationen för enkel inloggning med partnerflöden.
valfri
AP-Visitor-Identifier
Genereringen av nyttolasten för besökaridentifieraren beskrivs i rubrikdokumentationen för AP-Visitor-Identifier.
valfri
Acceptera
Medietypen som accepteras av klientprogrammet.

Om det anges måste det vara application/json.
valfri
Användaragent
Användaragenten för klientprogrammet.
valfri

Svar response

Code
Text
Beskrivning
200
OK
Svarstexten innehåller en lista med beslut med ytterligare information.
400
Felaktig begäran
Begäran är ogiltig. Klienten måste åtgärda begäran och försöka igen. Svarstexten kan innehålla felinformation som följer dokumentationen för Förbättrade felkoder.
401
Obehörig
Åtkomsttoken är ogiltig. Klienten måste hämta en ny åtkomsttoken och försöka igen. Mer information finns i dokumentationen Översikt över registrering av dynamisk klient.
405
Metoden tillåts inte
HTTP-metoden är ogiltig. Klienten måste använda en HTTP-metod som är tillåten för den begärda resursen och försök igen. Mer information finns i avsnittet Begäran.
500
Internt serverfel
Ett fel uppstod på serversidan. Svarstexten kan innehålla felinformation som följer dokumentationen för Förbättrade felkoder.

Lyckades success

Sidhuvuden
Status
200
obligatoriskt
Content-Type
application/json
obligatoriskt
Brödtext
beslut

JSON innehåller en lista med element, där varje element har följande attribut:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff 25-bgcolor-deebff layout-auto html-authored
Attribut
resurs Resursidentifieraren som förauktoriseringsbeslutet returneras för. obligatoriskt
serviceProvider Den interna unika identifierare som är associerad med tjänsteleverantören under introduktionsprocessen. obligatoriskt
mvpd Den interna unika identifierare som är associerad med identitetsleverantören under introduktionsprocessen. obligatoriskt
auktoriserad Beslutsstatusen för resursen, som kan vara antingen 'true' eller 'false'. obligatoriskt
källa

Information om beslutskälla:

Möjliga värden är:

  • mvpd
    Beslut utfärdas av MVPD-slutpunkten för förauktorisering.
  • degradering
    Beslut utfärdas som ett resultat av försämrad åtkomst.
  • mall
    Beslut utfärdas som ett resultat av tillfällig åtkomst.
  • dummy
    Beslut utfärdas som ett resultat av en overksam förauktoriseringsfunktion.
obligatoriskt
fel Felet ger ytterligare information om beslutet att neka som följer dokumentationen för förbättrade felkoder. valfri
obligatoriskt

Fel error

Sidhuvuden
Status
400, 401, 405, 500
obligatoriskt
Content-Type
application/json
obligatoriskt
Brödtext

Svarstexten kan innehålla ytterligare felinformation som följer dokumentationen för Förbättrade felkoder.

Klientprogrammet måste implementera en felhanteringsmekanism som kan hantera de felkoder som oftast returneras av denna API korrekt:

  • authenticated_profile_missing
  • authenticated_profile_utgången
  • preauthentication_deny_by_mvpd
  • network_receive_error
  • för_många_resurser
  • osv.

Förteckningen ovan är inte uttömmande. Klientprogrammet måste kunna hantera alla utökade felkoder som definieras i den offentliga dokumentationen.

obligatoriskt

Exempel samples

​1. Hämta förauktoriseringsbeslut med hjälp av specifik mvpd

Begäran
code language-https
POST /api/v2/REF30/decisions/preauthorize/Cablevision HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/json
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

{
    "resources": ["resource1", "resource2", "resource3"]
}
Svar
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
   "decisions": [
      {
         "resource": "resource1 ",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": true
      },
      {
         "resource": "resource2",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": true
      },
      {
         "resource": "resource3",
         "serviceProvider": "REF30",
         "mvpd": "Cablevision",
         "source": "mvpd",
         "authorized": false,
         "error": {
            "status": 403,
            "code": "preauthorization_denied_by_mvpd",
            "message": "The MVPD has returned a \"Deny\" decision when requesting pre-authorization for the specified resource.",
            "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=sv-SE",
            "action": "none"
         }
      }
   ]
}

​2. Hämta förauktoriseringsbeslut med hjälp av specifik mvpd när nedbrytning används

Begäran
code language-https
POST /api/v2/REF30/decisions/preauthorize/${degradedMvpd} HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/json
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

{
    "resources": ["REF30", "apasstest1"]
}
Svar - AuthNAll-degradering
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
    ]
}
Svar - AuthZAll-degradering
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": true
        }
    ]
}
Svar - AuthZNone-degradering
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "decisions": [
        {
            "resource": "REF30",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "authorization_denied_by_degradation_rule",
                "message": "The integration has an AuthZNone rule applied for the requested resources",
                "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=sv-SE",
                "action": "none"
            }
        }
        {
            "resource": "apasstest1",
            "serviceProvider": "REF30",
            "mvpd": "${degradedMvpd}",
            "source": "degradation",
            "authorized": false,
            "error": {
                "status": 403,
                "code": "authorization_denied_by_degradation_rule",
                "message": "The integration has an AuthZNone rule applied for the requested resources",
                "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=sv-SE",
                "action": "none"
            }
        }
    ]
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b