Recuperar decisões de pré-autorização usando mvpd específico
Última atualização: 6 de dezembro de 2024
- Tópicos:
- Authentication
IMPORTANTO conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual do Adobe. Não é permitida nenhuma utilização não autorizada.
IMPORTANTA implementação da REST API V2 é limitada pela documentação do Mecanismo de limitação.
Solicitação
HTTP
caminho
/api/v2/{serviceProvider}/decision/preauthorize/{mvpd}
método
POST
Parâmetros de caminho
serviceProvider
O identificador exclusivo interno associado ao provedor de serviços durante o processo de integração.
obrigatório
mvpd
O identificador exclusivo interno associado ao Provedor de identidade durante o processo de integração.
obrigatório
Parâmetros de corpo
recursos
A lista de recursos que exigem uma decisão MVPD antes de serem exibidos.
obrigatório
Cabeçalhos
Autorização
A geração da carga do token do portador está descrita na documentação do cabeçalho Autorização.
obrigatório
Tipo de conteúdo
O tipo de mídia aceito para os recursos que estão sendo enviados.
Deve ser application/json.
Deve ser application/json.
obrigatório
Identificador de dispositivo AP
A geração da carga do identificador de dispositivo está descrita na documentação do cabeçalho AP-Device-Identifier.
obrigatório
X-Device-Info
A geração da carga de informações do dispositivo está descrita na documentação do cabeçalho X-Device-Info.
É altamente recomendável sempre usá-lo quando a plataforma do dispositivo do aplicativo permitir a provisão explícita de valores válidos.
Quando fornecido, o back-end da Autenticação do Adobe Pass mesclará explicitamente valores definidos com valores extraídos implicitamente (por padrão).
Quando não for fornecido, o back-end da Autenticação do Adobe Pass usará os valores extraídos implicitamente (por padrão).
É altamente recomendável sempre usá-lo quando a plataforma do dispositivo do aplicativo permitir a provisão explícita de valores válidos.
Quando fornecido, o back-end da Autenticação do Adobe Pass mesclará explicitamente valores definidos com valores extraídos implicitamente (por padrão).
Quando não for fornecido, o back-end da Autenticação do Adobe Pass usará os valores extraídos implicitamente (por padrão).
obrigatório
X-Encaminhado-Para
O endereço IP do dispositivo de streaming.
É altamente recomendável sempre usá-lo para implementações de servidor para servidor, especialmente quando a chamada é feita pelo serviço do programador, em vez do dispositivo de transmissão.
Para implementações de cliente para servidor, o endereço IP do dispositivo de transmissão é enviado implicitamente.
É altamente recomendável sempre usá-lo para implementações de servidor para servidor, especialmente quando a chamada é feita pelo serviço do programador, em vez do dispositivo de transmissão.
Para implementações de cliente para servidor, o endereço IP do dispositivo de transmissão é enviado implicitamente.
opcional
Adobe-Subject-Token
A geração da carga de logon único para o método de identidade da plataforma está descrita na documentação do cabeçalho Adobe-Subject-Token.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando uma identidade de plataforma, consulte a documentação do Logon único usando fluxos de identidade de plataforma.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando uma identidade de plataforma, consulte a documentação do Logon único usando fluxos de identidade de plataforma.
opcional
AD-Service-Token
A geração da carga de logon único para o método Token de Serviço está descrita na documentação do cabeçalho AD-Service-Token.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando um token de serviço, consulte a documentação do Logon único usando fluxos de token de serviço.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando um token de serviço, consulte a documentação do Logon único usando fluxos de token de serviço.
opcional
AP-Partner-Framework-Status
A geração da carga de logon único para o método Partner está descrita na documentação do cabeçalho AP-Partner-Framework-Status.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando um parceiro, consulte a documentação do Logon único usando fluxos do parceiro.
Para obter mais detalhes sobre os fluxos habilitados para logon único usando um parceiro, consulte a documentação do Logon único usando fluxos do parceiro.
opcional
Aceitar
O tipo de mídia aceito pelo aplicativo cliente.
Se especificado, deve ser application/json.
Se especificado, deve ser application/json.
opcional
User-Agent
O agente do usuário do aplicativo cliente.
opcional
Resposta
Código
Texto
Descrição
200
OK
O corpo da resposta contém uma lista de decisões com informações adicionais.
400
Solicitação inválida
A solicitação é inválida, o cliente precisa corrigir a solicitação e tentar novamente. O corpo da resposta pode conter informações de erro que seguem a documentação de Códigos de erro aprimorados.
401
Não autorizado
O token de acesso é inválido, o cliente precisa obter um novo token de acesso e tentar novamente. Para obter mais detalhes, consulte a documentação Visão geral do registro dinâmico do cliente.
405
Método não permitido
O método HTTP é inválido, o cliente precisa usar um método HTTP permitido para o recurso solicitado e tentar novamente. Para obter mais detalhes, consulte a seção Solicitação.
500
Erro interno do servidor
O servidor encontrou um problema. O corpo da resposta pode conter informações de erro que seguem a documentação de Códigos de erro aprimorados.
Sucesso
Cabeçalhos
Status
200
obrigatório
Tipo de conteúdo
application/json
obrigatório
Corpo
decisões
JSON contendo uma lista de elementos, cada elemento com os seguintes atributos:
Atributo
recurso
O identificador de recurso para o qual a decisão de pré-autorização é retornada.
obrigatório
serviceProvider
O identificador exclusivo interno associado ao provedor de serviços durante o processo de integração.
obrigatório
mvpd
O identificador exclusivo interno associado ao Provedor de identidade durante o processo de integração.
obrigatório
authorized
O status de decisão do recurso, que pode ser 'true' ou 'false'.
obrigatório
origem
Informações sobre a fonte de decisão:
Os valores possíveis são:
- mvpd
A decisão é emitida pelo ponto de extremidade de pré-autorização do MVPD. - degradação
A decisão é emitida como resultado de acesso degradado. - temppass
A decisão é emitida como resultado de acesso temporário. - fictício
A decisão é emitida como resultado do recurso de pré-autorização fictício.
obrigatório
erro
O erro fornece informações adicionais sobre a decisão de 'Negação' que segue a documentação de Códigos de erro aprimorados.
opcional
obrigatório
Erro
Cabeçalhos
Status
400, 401, 405, 500
obrigatório
Tipo de conteúdo
application/json
obrigatório
Corpo
O corpo da resposta pode fornecer informações adicionais de erro que seguem a documentação de Códigos de erro aprimorados.
obrigatório
Amostras
1. Recuperar decisões de pré-autorização usando mvpd específico
Solicitação
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"]
}
Resposta
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=pt-BR",
"action": "none"
}
}
]
}
2. Recuperar decisões de pré-autorização usando mvpd específico enquanto a degradação é aplicada
Solicitação
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"]
}
Resposta - Degradação AuthNAll
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
}
]
}
Resposta - Degradação de AuthZAll
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
}
]
}
Resposta - Degradação de AuthZNone
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=pt-BR",
"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=pt-BR",
"action": "none"
}
}
]
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b