Referência da API REST rest-api-reference

NOTE
O 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.

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:
  • Definir cabeçalho HTTP Accept para application/xml ou application/json.
  • Na carga da solicitação, especifique o parâmetro format=xml ou format=json.
  • Chamar 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
Adobe
Serviço de código de registro
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
Adobe
Serviço de código de registro
Adobe Pass Authentication
3.
<sp_fqdn>/api/v1/config/
{requestorId}
Retorna a lista de MVPDs configurados para o solicitante
5
Adobe
Adobe Pass
autenticação
Serviço
Logon
Web
Aplicativo
4.
<sp_fqdn>/api/v1/authenticate
Inicia o processo de Autenticação informando o evento de seleção MVPD. Cria um registro no banco de dados de autenticação, que é reconciliado quando uma resposta bem-sucedida é recebida do MVPD (Etapa 13)
7
Adobe
Adobe Pass
autenticação
Serviço
Logon
Web
Aplicativo
5.
Consumidor de Asserção SAML
Fluxo de trabalho SAML existente entre a Autenticação do Adobe Pass e o MVPD
13
Adobe Pass
autenticação
Serviço
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
Adobe Pass
autenticação
Serviço
Logon
Web
Aplicativo
7.
<sp_fqdn>/api/v1/tokens/authn
Obtém metadados relacionados ao token de Autenticação
15
Adobe Pass
autenticação
Serviço
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
Adobe
Serviço de código de registro
Adobe Pass Authentication
9.
<sp_fqdn>/api/v1/authorize
Obtém a resposta de autorização.
17
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
10.
<sp_fqdn>/api/v1/checkauthn
Indica se o dispositivo tem um token de autenticação não expirado.
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
11.
<sp_fqdn>/api/v1/tokens/authn
Retorna o token de autenticação se for encontrado.
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
12.
<sp_fqdn>/api/v1/tokens/authz
Retorna o token de AuthZ, se encontrado.
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
13.
<sp_fqdn>/api/v1/tokens/media
Retorna o token de mídia curta se encontrado - o mesmo que /api/v1/mediatoken
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
14.
<sp_fqdn>/api/v1/mediatoken
Obtém O Token De Mídia Curta
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
15.
<sp_fqdn>/api/v1/preauthorize
Recupera a lista de recursos pré-autorizados
Adobe Pass
autenticação
Serviço
Dispositivo inteligente
16.
<sp_fqdn>/api/v1/preauthorize/{code}
Recupera a lista de recursos pré-autorizados
Adobe Pass
autenticação
Serviço
Aplicativo Web de Logon
17.
<sp_fqdn>/api/v1/logout
Remover tokens AuthN e AuthZ do armazenamento
Adobe Pass
autenticação
Serviço
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
Adobe Pass
autenticação
Serviço
Dispositivo inteligente

Segurança da API REST security

Todas as APIs sem cliente da Autenticação 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 fornecido pelo Registro de cliente dinâmico.

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b