Requisitos

Conhecimento necessário

  • Noções básicas sobre o AEM Mobile
  • Conhecimento sobre criação e publicação de conteúdo por meio do portal sob demanda
  • Experiência com On-Demand Services APIs

Produtos necessários

  • AEM Mobile
  • Acesso à On-Demand Services API

Introdução

O Adobe Experience Manager Mobile (AEM Mobile) oferece uma poderosa On-Demand Services API, que permite gerenciar programaticamente artigos, coleções, produtos, notificações por push e muito mais. A API também permite a integração de terceiros com sistemas de gerenciamento de conteúdo, ferramentas de criação baseadas na Web e sistemas de fluxo de trabalho de publicação, muitos dos quais estão disponíveis agora. (Consulte Integrar sistemas de terceiros ao AEM Mobile para saber mais detalhes.)

Se desejar escrever o código personalizado que faz interface com a On-Demand Services API ou aproveitar uma das integrações existentes com sistemas de terceiros, você precisará de credenciais de API válidas. Este artigo explica como as chaves de API são usadas.

 

Credenciais de API

As credenciais de API consistem nos seguintes itens:

  • A chave da API e o segredo do cliente são credenciais para acessar o gateway da API.
  • A ID do dispositivo e o token do dispositivo são credenciais para identificar o usuário da API.

Situações de uso e requisitos da API

Dependendo de como você pretende se conectar por meio de On-Demand Services APIs, os seguintes requisitos se aplicam.

Solução hospedada (multilocatária)

Exemplos: WoodWing Enterprise, WoodWing Inception, Storied e Specle.

  • Cada solução hospedada exige sua própria chave de API.
  • Os usuários da solução hospedada não precisam de sua própria chave de API.
  • O proprietário da solução fornece esta chave de API aos usuários/clientes.
  • Os usuários da solução hospedada geram sua própria ID do dispositivo e token do dispositivo usando essa chave da API e, em seguida, inserem essas credenciais na solução hospedada.

Solução local (locatário único)

Exemplos: Adobe Experience Manager, vjoon K4, WordPress e Drupal.

  • Cada cliente que deseja implementar uma solução local precisa de sua própria chave de API.
  • Um cliente pode utilizar sua chave de API em várias soluções locais que ele implemente.
  • Um cliente precisa gerar sua própria ID do dispositivo e token do dispositivo, além de inserir essas credenciais em sua solução local.

Integração personalizada

Exemplo: o fluxo de trabalho personalizado codificado por um parceiro ou por um cliente.

  • Mesmos requisitos que a caixa local (locatário único).
  • O cliente precisa de sua própria chave da API, ID(s) do dispositivo e token(s) do dispositivo.

Consulte as seções a seguir para obter informações sobre como adquirir as credenciais da API de que você precisa.

Solicitação de uma chave de API

Uma chave de API é usada para obter acesso ao gateway de API da Adobe. Este gateway é uma infraestrutura comum que também está sendo usada pelas APIs. Todas as APIs públicas estão atrás do gateway de API da Adobe. Para poder interagir com serviços atrás do gateway de API, você precisa de uma chave de API. As chaves de API não estão ligadas a uma Adobe ID individual, e não expiram a menos que a Adobe as revogue. A chave de API consiste em duas partes: o nome e o segredo. Você pode considerar o segredo como “senha” para a chave de API.

A chave de API e o segredo do cliente às vezes são mencionados com outros nomes. Os seguintes termos são equivalentes:

Chave da API = “ID do cliente IMS” = “ID de cliente” = “chave de API da Adobe” = “chave Adobe”

Segredo do cliente = “segredo” = “Segredo de API da Adobe” = “segredo Adobe”

Para solicitar uma chave de API, baixe e envie o formulário PDF de solicitação. Para obter detalhes, consulte Integrar sistemas de terceiros ao AEM Mobile: chaves de API.

A recomendação é NÃO usar Adobe IDs do administrador mestre para o acesso à API. Use as contas de administrador mestre apenas para criar projetos e adicionar contas dedicadas a cada um dos projetos necessários. Por exemplo, se você tiver uma ocorrência do Drupal e uma ocorrência do WordPress, e seu administrador mestre for aemm_master@adobe.com, sua Adobe ID dedicada de API para Drupal poderia ser aemm_drupal@adobe.com (um administrador não mestre). Sua Adobe ID dedicada para o WordPress poderia ser aemm_wordpress@adobe.com (um administrador não mestre). Então, é possível, por exemplo, criar projetos chamados “Drupal Mag” e “WordPress Mag” com aemm_master@adobe.com e adicionar aemm_drupal@adobe.com e aemm_wordpress@adobe.com a esses projetos apenas com as funções e as permissões necessárias. Conceda apenas as permissões a essas contas de API dedicadas que são necessárias para seu uso pretendido da API, como “Adicionar e editar conteúdo”, “Excluir conteúdo”, “Exibir conteúdo” e “Publicar conteúdo”. Consulte a documentação referente à solução para obter as permissões específicas que são necessárias. Consulte Administração de contas do AEM Mobile.

Se sua solicitação for concedida, você receberá uma ID do cliente IMS (que é sua chave de API) e o segredo do cliente. Suas Adobe IDs especificadas serão colocadas na “lista de permissões” para que você possa criar IDs do dispositivo e tokens do dispositivo associados, como descrito no conjunto de etapas seguinte.

 

 

 

Geração da ID do dispositivo e do token do dispositivo

Uma vez que você tem uma chave de API e um segredo do cliente, é necessário gerar uma ID do dispositivo e um token do dispositivo, que são usados para identificar o usuário da API.

  1. Visite o gerador de token do dispositivo IMS (“portal AEX”) em https://aex.aemmobile.adobe.com/ e insira sua chave da API/ID do cliente IMS.
  2. Faça logon usando a Adobe ID permitida para a qual deseja criar uma ID/Token de dispositivo (uma das Adobe IDs que você especificou no formulário de solicitação de chave da API).
  3. Uma ID do dispositivo e um token de dispositivo serão gerados e exibidos. Copie-os e salve-os em um local seguro.

Observe que a ID do dispositivo/o token de dispositivo se torna inválido se a senha da Adobe ID for alterada. Você pode considerar a ID do dispositivo/o token de dispositivo como um hash da Adobe ID e senha.

Observe também que a ID do dispositivo/o token de dispositivo é válido por 6 meses e ficará inválido se não for usado. Se estiver sendo usado, a renovação será automática.

Acesso à AEM Mobile API

Se estiver conectando um sistema de terceiros com suporte por meio de APIs, basta especificar a chave da API e o segredo do cliente (somente para soluções locais/de locatário único), a ID do dispositivo e o token do dispositivo nos campos apropriados ao configurar o sistema.

Se você estiver acessando a API diretamente em seu próprio código personalizado, siga a documentação no pacote da On-Demand Services API:

  • A ID do dispositivo/o token de dispositivo são usados para gerar um token de acesso por meio do ponto de extremidade da API de autenticação.
  • A combinação da chave de API e do token de acesso é necessária para todas as chamadas de API.

Uso de chaves da API em ambientes de desenvolvimento e produção

Se estiver desenvolvendo uma integração personalizada, ou se tiver sistemas separados de produção e desenvolvimento no local, você deverá usar chaves de API separadas para o desenvolvimento e a produção.

Quando estiver desenvolvendo um sistema novo, você pode solicitar uma chave da API com o procedimento descrito acima. Depois que você começar a implementar um sistema na produção, é necessário solicitar uma chave de API adicional.

Suspensão gradual de contas técnicas da ID do dispositivo e do token do dispositivo

Futuramente, o fluxo de trabalho da ID do dispositivo e do token do dispositivo será substituído por uma nova implementação de conta técnica gerenciada pelo portal sob demanda. As chaves de API permanecerão em uso. Em vez de usar uma ID do dispositivo e o token do dispositivo para autenticar (e obter um token de acesso), o sistema fornecerá uma “conta técnica” que pode ser usada para solicitar o token de acesso. Para vincular o processo, um “token único” será gerado. Esse identificador pode ser usado apenas uma vez. O consumidor das informações da conta trocará o token único por um token de autenticação com um serviço da Adobe. O token resultante pode ser armazenado para autenticação futura.

Esta obra está licenciada sob uma licença não adaptada da Creative Commons Attribution-Noncommercial-Share Alike 3.0  As publicações do Twitter™ e do Facebook não são cobertas pelos termos do Creative Commons.

Avisos legais   |   Política de privacidade online