Referência da API REST (herdada) rest-api-reference

NOTE
O conteúdo desta página é fornecido apenas para fins informativos. O uso desta API requer uma licença atual da Adobe. Não é permitida nenhuma utilização não autorizada.
IMPORTANT
Mantenha-se informado sobre os anúncios mais recentes do produto de Autenticação da Adobe Pass e as linhas do tempo de desativação agregadas na página Anúncios de produto.

Mecanismo de limitação

A API REST de Autenticação do Adobe Pass é regida por um Mecanismo de limitação.

Formatos de resposta response-formats

NOTE
As APIs fornecidas nesses serviços podem retornar respostas em XML ou JSON (para APIs que retornam uma resposta). Há três maneiras diferentes de especificar o formato de resposta na solicitação:
  • Defina o Cabeçalho Aceitar HTTP como application/xml ou application/json.
  • Na carga da solicitação, especifique o parâmetro format=xml ou format=json.
  • Chame o ponto de extremidade do serviço Web com extensão .xml ou .json. Por exemplo, /regcode.xml ou /regcode.json
Você pode especificar qualquer um dos métodos acima. A especificação de vários métodos com formatos conflitantes pode resultar em erros ou em saídas indesejáveis.

Endpoints da REST API clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Resumo dos serviços da Web web_srvs_summary

A tabela abaixo lista os serviços Web disponíveis para a abordagem sem cliente. Clique nos pontos finais dos serviços da Web para obter mais informações (amostra de solicitação e resposta, parâmetros de entrada, métodos HTTP etc.)

​| Sr | Ponto Final do Serviço Web | Descrição | . | Hospedado em | Chamado por |
|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|-----------------------------------------------------------|-----------------------------|
| 1. | <REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
| Retorna o código de registro gerado aleatoriamente e o URI da página de logon | 2 | Serviço de código do Adobe
Reg | Dispositivo inteligente |
| 2. | <REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
| Retorna o registro do código de registro contendo o código de registro UUID, o código de registro e a ID do dispositivo com hash | 8 | Serviço de código do Adobe
Reg | Adobe Pass Authentication |
| 3. | <SP_FQDN>/api/v1/config/
{requestorId}
| Retorna a lista de MVPDs configurados para o solicitante | 5 | Serviço
de autenticação
do Adobe Pass
do Adobe | Logon
Aplicativo
Web |
| 4. | <SP_FQDN>/api/v1/authenticate | Inicia o processo de Autenticação informando o evento de seleção do MVPD. Cria um registro no banco de dados de autenticação, que é reconciliado quando uma resposta bem-sucedida é recebida do MVPD (Etapa 13) | 7 | Serviço
de autenticação
do Adobe Pass
do Adobe | Logon
Aplicativo
Web |
| 5. | Consumidor de Asserção SAML | Fluxo de trabalho SAML existente entre a Autenticação do Adobe Pass e o MVPD | 13 | Serviço
de autenticação
do Adobe Pass | Adobe Pass Authentication |
| 6. | <SP_FQDN>/api/v1/checkauthn/
{registrationCode}
| O Aplicativo Web de Logon pode verificar se a tentativa de fluxo de logon foi bem-sucedida | | Serviço
de autenticação
do Adobe Pass | Logon
Aplicativo
Web |
| 7. | <SP_FQDN>/api/v1/tokens/authn | Obtém metadados relacionados ao token de Autenticação | 15 | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 8. | <REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
| Exclui o registro de código regulamentar e libera o código regulamentar para reutilização | 16 | Serviço de código do Adobe
Reg | Adobe Pass Authentication |
| 9. | <SP_FQDN>/api/v1/authorize | Obtém a resposta de autorização. | 17 | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 10. | <SP_FQDN>/api/v1/checkauthn | Indica se o dispositivo tem um token de autenticação não expirado. | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 11. | <SP_FQDN>/api/v1/tokens/authn | Retorna o token de autenticação se for encontrado. | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 12. | <SP_FQDN>/api/v1/tokens/authz | Retorna o token de AuthZ, se encontrado. | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 13. | <SP_FQDN>/api/v1/tokens/media | Retorna o token de mídia curta se encontrado - o mesmo que /api/v1/mediatoken | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 14. | <SP_FQDN>/api/v1/mediatoken | Obtém O Token De Mídia Curta | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 15. | <SP_FQDN>/api/v1/preauthorize | Recupera a lista de recursos pré-autorizados | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 16. | <SP_FQDN>/api/v1/preauthorize/{code} | Recupera a lista de recursos pré-autorizados | | Serviço
de autenticação
do Adobe Pass | Aplicativo Web de Logon |
| 17. | <SP_FQDN>/api/v1/logout | Remover tokens AuthN e AuthZ do armazenamento | | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |
| 18. | <SP_FQDN>/api/v1/tokens/usermetadata | Obtém metadados do usuário após a conclusão do fluxo de autenticação | N/A | N/A | Dispositivo inteligente |
| 19. | <SP_FQDN>/api/v1/authenticate/freepreview | Criar um token de autenticação para Aprovação Temporária ou Aprovação Temporária Promocional | N/A | Serviço
de autenticação
do Adobe Pass | Dispositivo inteligente |

Segurança da API REST security

Todas as APIs REST de Autenticação do Adobe Pass devem ser chamadas usando o protocolo HTTPS para comunicação segura. Além disso, a maioria das APIs chamadas deve conter um token de acesso obtido conforme descrito na documentação da API Recuperar token de acesso.

recommendation-more-help
pass-help-authentication