Requisitos

Conocimientos previos necesarios

  • Explicación de AEM Mobile
  • Conocimientos sobre creación y publicación de contenido a través del portal bajo demanda estándar

Productos requeridos

  • AEM Mobile

Introducción

Las On-Demand Services API de Adobe Experience Manager permiten que un desarrollador externo se integre con los servicios bajo demanda. Estos servicios le permiten lo siguiente:

  • Gestionar artículos
  • Gestionar colecciones
  • Gestionar productos
  • Gestionar notificaciones push

Las On-Demand Services APl (anteriormente denominadas “Content Producer Service API”) son las mismas API utilizadas en el portal bajo demanda (https://aemmobile.adobe.com).

Content Producer Service API de Adobe Digital Publishing Solution

Integración con la creación de AEM

Puede utilizar AEM con el fin de crear contenido para las aplicaciones de AEM Mobile. Para obtener más información, póngase en contacto con su representante de Adobe.

Integraciones de terceros

Existen integraciones disponibles (de los socios de Adobe) para los sistemas de flujo de trabajo editorial, los sistemas de gestión de contenido (CMS) y las soluciones de creación basadas en la web que se indican a continuación:

Sistemas CMS

  • Wordpress (desarrollado por Studio Mercury)
  • Drupal (desarrollado por DPCI)
Creación basada en la web
Sistemas de flujo de trabajo

Tutorial en vídeo sobre CMS

Integrar con CMS: Drupal y WordPress (en inglés)

Descripción general de los vídeos sobre integración

Klaasjan Tukker y Mike Yang ofrecieron esta presentación sobre las posibilidades avanzadas del flujo de trabajo en la conferencia MAX 2015:

Posibilidades de flujo avanzado de trabajo con las API de Adobe (en inglés) (1:25:57)

Descargas

Para comenzar a trabajar con la On-Demand Services API, descargue los archivos que se indican a continuación.

Nota:

Al descargar el software enumerado a continuación, reconozco haber leído y aceptar las condiciones de la Licencia de las API para servicios de AEM Mobile, de las Condiciones de uso de Adobe.com y de la Política de privacidad en línea de Adobe.

Descargar

Este archivo .zip contiene los siguientes elementos:

  • Documentación de la API
  • Definiciones del esquema JSON
  • Ejemplos de código
  • Ejemplos de scripts de InDesign
  • Formulario de solicitud de la clave de API

 

Cómo utilizar la documentación de la API

Para ver la documentación de la API (creada con Swagger), descomprima los archivos en una carpeta de su servidor web (por ejemplo, MAMP).

Si la URL alojada en la documentación de swagger es http://localhost:8888/aemmobile-swagger, puede omitir el paso siguiente.

Abra el archivo “service.json” y modifique la línea n.º 55 para establecer el valor de basePath en función del host y la ruta donde se encuentra su documentación. Por ejemplo:

#53     "contact": "wwds@adobe.com"
#54   },
#55   "basePath": "http://localhost:8888/your-custom-path"
#56 }

Abra el navegador web y vaya a la ubicación en la que haya colocado la documentación. La On-Demand Services API debe estar visible.

 

Configuración del proyecto, las funciones y los usuarios

Configure un proyecto, cree funciones y conceda acceso a los usuarios. Para obtener más información, consulte los siguientes artículos de ayuda:

Una buena práctica consiste en evitar el uso de un Adobe ID al que se hayan concedido los derechos de administración de “Cuenta maestra” o “Todo el proyecto”. Cree un Adobe ID que tenga acceso únicamente a las operaciones que desea permitir que se realicen mediante la On-Demand Services API.

Nota:

Para ejecutar los ejemplos que se muestran a continuación, asegúrese de comenzar con un nuevo proyecto.

Claves de API

Para acceder a la On-Demand Services API e integrarla con sistemas de terceros, necesita una clave de API.

Solicitud de una clave de API

Para acceder a la On-Demand Services API, debe solicitar una clave de API. Para solicitarla, rellene el formulario en PDF. Envíe el formulario cumplimentado al servicio de soporte para desarrolladores de Adobe: wwds@adobe.com

Descargar

Para obtener más información acerca de si necesita la clave de API o si debe utilizar una existente, consulte Uso de clave de API de AEM Mobile.

Generación del device_id y el device_token

Una vez que haya recibido su clave de API, puede generar el device_id y el device_token. Vaya a https://aex.aemmobile.adobe.com y haga lo siguiente:

  • Proporcione la clave de API.
  • Inicie sesión con un Adobe ID que haya solicitado a la lista blanca (en el formulario de solicitud).

Si se cumplen todas las condiciones, se generará un device_id y un device_token.

Cómo utilizar los archivos de ejemplo

Descomprima los ejemplos y cambie los valores estándar para que aparezcan su cuenta y claves de API. Asegúrese de que ha creado un proyecto nuevo en el portal a petición y que se asigna una función al Adobe ID que se usará para comunicarse en los ejemplos de la API.

Cambie:

  • config/credentials.php

Cambie o añada los valores para “client_id” (su clave de API), “client_secret”, “device_token” y “device_id” (del servicio AEX).

Defina el valor de “client_version”; sirve para identificar su “sistema” en comunicación con la On-Demand Services API. Por ejemplo, “aemmobile-learn-api-doc -1.0”.

Ejecute:

  • demo/01_get_access_token.php

Si se define correctamente, la respuesta debería proporcionarle un “access_token”. Utilice este access_token en las llamadas de servicio de seguimiento.

Cambie:

  • config/credentials.php

Añada el valor de “access_token”.

Ejecute:

  • demo/02_get_user_permissions.php

Si se ha configurado correctamente, la respuesta debe proporcionar una lista de proyectos a los que el Adobe ID (para el que se generó el device_id o el device_token) tiene acceso.

Seleccione el proyecto con el que desea interactuar (debe tratarse de un proyecto nuevo, de creación reciente). La identificación del proyecto es un GUID como “8dbeb5da-ca73-d0da-b0b0-885fb83e7ae8”.

Cambie:

  • Config/parameters.php

Actualice “publication_id” con su ID de proyecto, obtenido antes.

Ejecute:

  • demo/03_update_home_collection.php

Si se ha configurado correctamente, le permitirá que la colección de nivel superior pueda pasar a un estado publicable al cargar tanto la imagen en miniatura como la imagen de fondo, establecer el ID de producto y asociar el diseño predeterminado.

Cambie:

  • config/parameters.php

Si el proyecto de destino es una colección de nivel superior 2, actualice el valor de 'collection_home_name' de 'topLevelContent' a 'topLevelTabletContent' para tablets (o 'topLevelPhoneContent' para teléfonos).

Ahora está listo para ejecutar el resto de los ejemplos. Cuando se estén ejecutando los ejemplos, mantenga un navegador con el portal a petición abierto en la sección “Contenido y diseños” para sus proyectos. Puede ver los cambios que se producen en vivo en el navegador, mientras se ejecutan los ejemplos.

 

Creación de artículos

El contenido de los artículos se puede crear con HTML o InDesign.

Artículos HTML

Los artículos creados con HTML pueden utilizar CSS/JS para diseñar visualmente el contenido y hacerlo interactivo. Todo el contenido HTML debe estar en la misma carpeta (deben permitirse las subcarpetas). Los archivos HTML se empaquetarán en un archivo .zip con un archivo manifest.xml. El archivo manifest muestra qué artículos forman parte del paquete de artículos y contiene la suma de comprobación de MD5 (consulte Creación de artículos HTML para AEM Mobile).

Para generar los archivos de artículos de una carpeta, puede hacer uso de la utilidad de escritorio o emplear el empaquetador de ejemplo de “class/manifest.php”.

Artículos de InDesign

Con Adobe InDesign CS6 o posterior, puede crear archivos de artículos de diseño fijo. Mediante el complemento Digital Publishing, puede exportar el contenido de InDesign a un archivo de artículo (consulte Creación de artículos de AEM Mobile en InDesign).

Para crear un script del proceso de exportación, puede utilizar la función “exportDpsArticle”. Para obtener información, consulte Creación de artículos con InDesign mediante scripts.

Preguntas y soporte

El foro de integración/API está disponible para publicar cualquier pregunta relacionada con este artículo o el uso de las On-Demand Services API. Si desea obtener soporte personalizado, póngase en contacto con el servicio de soporte para desarrolladores de Adobe (wwds@adobe.com).

Registro de cambios

20 de junio de 2017

Documentación actualizada:

  • Errata corregida en la descripción.

7 de febrero de 2017

Documentación actualizada:

  • Se ha añadido compatibilidad de contenido compartido dinámico a través de proveedores de Producer Services.

Esquema JSON actualizado:

  • Se ha añadido el nuevo esquema JSON para contenido compartido dinámico.

Ejemplos de API:

  • Se ha añadido soporte para contenido compartido dinámico.

1 de noviembre de 2016

Documentación actualizada:

  • Se ha añadido la devolución por lotes del estado de la entidad.
  • Se ha añadido compatibilidad de pancartas dinámicas a través de proveedores de Producer and Ingestion Services.
  • Se ha añadido compatibilidad de notificaciones push de Android mediante la API de servicio de notificaciones.
  • Se ha añadido la capacidad de actualizar la lista de elementos de contenido de la colección en el índice especificado.

Esquema JSON actualizado:

  • Se ha añadido el nuevo esquema JSON para pancartas dinámicas.

Ejemplos de API actualizados:

  • Actualiza Collection::updateContentElements() para comprobar si ya existe antes de añadir la entidad a la lista de elementos del contenido de la colección.
  • Se ha añadido compatibilidad de pancartas dinámicas.
  • Se ha añadido pancartas dinámicas a scripts de demostración (13-15).

12 de julio de 2016

Documentación actualizada:

  • Producto y paquete del producto actualizados

30 de junio de 2016

Documentación actualizada:

  • Se ha añadido información sobre la carga de PDF del servicio de inserción

Esquema de JSON actualizado: 12 de julio de 2016

Documentación actualizada:

  • Campos adicionales de metadatos añadidos:
    • contentSize
    • availabilityDate (solo producto y paquete del producto)
    • availabilityDateTimezone (solo producto y paquete del producto)

Ejemplos de API actualizados:

  • Demostración: n.º 05e, actualizar archivo PDF al artículo uno
  • Demostración: n.º 05f, actualizar archivo PDF al artículo uno y configurar el barrido horizontal
  • Demostración: n.º 05g, comprobar estado de inserción del artículo uno
  • Se ha modificado para utilizar el cargador automático con el fin de cargar las clases necesarias por script PHP

10 de mayo de 2016

Documentación actualizada:

  • Ahora, el servicio de inserción acepta el encabezado: application/pdf
  • Seguir el estado de trabajos conocidos, publicados o sin publicar y de publicación previa
    • POST /job devolverá un ID de flujo de trabajo para este trabajo
    • GET /status/{publicationID}/publication/00000000-0000-0000-0000-000000000000 devolverá el ID actual de flujo de trabajo (si está disponible)
    • Comparar el Id de flujo de trabajo actual (si está disponible) con el último Id de flujo de trabajo conocido
      • En el caso de ID actual de flujo de trabajo === último ID conocido de flujo de trabajo, el último trabajo sigue en progreso
      • En el caso de ID actual de flujo de trabajo !== último ID conocido de flujo de trabajo, se ha finalizado el último trabajo y otro está en ejecución
      • En caso de que el ID actual de flujo de trabajo esté vacío, el último trabajo se ha finalizado y no hay ningún otro en ejecución

Ejemplos de API actualizados:

  • Demostración: n.º 05d, comprobar el tamaño del contenido del archivo cargado actualmente
  • Demostración: n.º 08c, seguimiento del estado del último flujo de trabajo conocido

Esta obra está autorizada con arreglo a la licencia de Reconocimiento-NoComercial-CompartirIgual 3.0 Unported de Creative Commons.  Los términos de Creative Commons no cubren las publicaciones en Twitter™ y Facebook.

Avisos legales   |   Política de privacidad en línea