Documentación AEM Guides Documentación de AEM Guides

Introducción id1761C0007W7

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Introducción a API

Creado para:

Experimentado
Desarrollador

Adobe Experience Manager Guides (más adelante denominado AEM Guides) es una solución empresarial integral que permite a Adobe Experience Manager AEM () disponer de funcionalidades de la solución de administración de contenido de componentes (CCMS) para la creación y entrega de contenido basado en DITA. Los clientes pueden acceder a los flujos de trabajo de AEM Guides mediante programación utilizando las API de AEM Guides para integrarlos con otras aplicaciones empresariales. Estas API también las pueden utilizar los socios de Adobe para mejorar la propuesta de valor de AEM Guides ampliando su funcionalidad o integrándola con otras aplicaciones o servicios.

API de AEM Guides

Las API de AEM Guides están disponibles en dos formatos: HTTP y Java. Estas API exponen funciones clave de AEM Guides a los desarrolladores de aplicaciones. Con estas funciones, los desarrolladores pueden crear sus propios complementos para ampliar los flujos de trabajo predeterminados. Las API están disponibles para administrar salidas para contenido DITA, trabajar con mapas DITA, añadir atributos condicionales a perfiles de nivel de carpeta y convertir documentos de HTML y de Word a formato DITA.

Instalación de los JAR en el repositorio local de Apache Maven install-jar-local

Para poder utilizar los archivos JAR expuestos por AEM Guides, debe instalarlos en su repositorio local de Apache Maven. Siga estos pasos para instalar los JAR en su ubicación del repositorio de Maven:

Extraiga el contenido del archivo (.zip) del paquete de AEM Guides en el sistema local.

En el símbolo del sistema, vaya a la siguiente carpeta en la ruta de contenido extraída:

code language-none
`\jcr_root\libs\fmdita\osgi-bundles\install`

Ejecute el siguiente comando para instalar el paquete de API en el repositorio local de Maven:

code language-none
`mvn install:install-file -Dfile=api-X.x.jar -DgroupId=com.adobe.fmdita -DartifactId=api -Dversion=X.x -Dpackaging=jar**`

note note
NOTE
En el comando anterior, X.x debe reemplazarse por el número de versión real en los parámetros Dfile y Dversion.

(Opcional) Instale la dependencia en el repositorio local del proyecto Maven. Puede conseguirlo creando una carpeta en su proyecto Maven y luego ejecutando el comando mvn install dado en el paso anterior con el siguiente parámetro adicional:

code language-none
`-DlocalRepositoryPath=<path_to_project_repository>`

A continuación, para exponer la carpeta de repositorio local del proyecto al proceso de generación de Maven, agregue un elemento repository en el archivo pom.xml principal como se muestra a continuación:

code language-xml
`<repositories> <repository> <id>project-repository</id> <url>file://${project.basedir}/repository</url> </repository> </repositories>`

Este proceso instala los JAR de API en el repositorio local de Maven.

Uso del JAR de la API de servicio en un proyecto de Maven

Después de instalar los JAR de API en el repositorio local de Maven, realice los siguientes pasos para utilizar el JAR en sus proyectos:

Añada el JAR a la base de código y confírmelo en el repositorio de la base de código en una carpeta, como "dependencias". Tenga en cuenta que el nombre de la carpeta depende de la jerarquía base de código.

Configure los archivos pom.xml del proyecto de la siguiente manera:

Archivo pom.xml del proyecto principal:

note important
IMPORTANT
En el siguiente fragmento de código, X.x debe reemplazarse por el número de versión real y el nombre de archivo del JAR de la API. Esta información será la misma que se proporciona en el paso 3 del proceso de instalación.

code language-xml

code language-xml
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> <configuration> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>X.x</version> <file>${basedir}/dependencies/fmdita/api-X.x.jar</file> <packaging>jar</packaging> <generatePom>true</generatePom> </configuration> <executions> <execution> <id>inst_fmdita</id> <goals> <goal>install-file</goal> </goals> <phase>clean</phase> </execution> </executions> </plugin>

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

   <artifactId>maven-install-plugin</artifactId>

    <version>2.5.2</version>

    <configuration>

            <groupId>com.adobe.fmdita</groupId>

            <artifactId>api</artifactId>

            <version>X.x</version>

            <file>${basedir}/dependencies/fmdita/api-X.x.jar</file>

            <packaging>jar</packaging>

            <generatePom>true</generatePom>

    </configuration>

    <executions>

        <execution>

            <id>inst_fmdita</id>

                <goals>

                    <goal>install-file</goal>

                </goals>

                <phase>clean</phase>

        </execution>

    </executions>
</plugin>

Archivo pom.xml del módulo secundario:

code language-xml

code language-xml
`<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-install-plugin</artifactId> <configuration> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>3.6</version> <file>${basedir}/../dependencies/fmdita/api-3.6.jar</file> <packaging>jar</packaging> <generatePom>true</generatePom> </configuration> <executions> <execution> <id>inst_fmdita</id> <goals> <goal>install-file</goal> </goals> <phase>clean</phase> </execution> </executions> </plugin>`

<plugin>
   <groupId>org.apache.maven.plugins</groupId>

   <artifactId>maven-install-plugin</artifactId>

   <configuration>

      <groupId>com.adobe.fmdita</groupId>

      <artifactId>api</artifactId>

      <version>3.6</version>

      <file>${basedir}/../dependencies/fmdita/api-3.6.jar</file>

      <packaging>jar</packaging>

      <generatePom>true</generatePom>

   </configuration>

   <executions>

      <execution>

         <id>inst_fmdita</id>

         <goals>

            <goal>install-file</goal>

         </goals>

         <phase>clean</phase>

      </execution>

   </executions>

</plugin>

Configure y utilice el JAR de la API de servicio del repositorio público de Maven

Realice los siguientes pasos para configurar y utilizar los JAR de la API de servicio del repositorio público de Maven en sus proyectos:

Para utilizar el JAR de la API de servicio en un proyecto, configure el repositorio Maven público de AEM Guides en el archivo pom.xml.

Configure el repositorio público de Maven en el archivo settings.xml de Maven de la siguiente manera:

code language-xml
`<repository> <id>fmdita-public</id> <name>fmdita-public</name> <url>https://repo.aem-guides.com/repository/fmdita-public</url> </repository>`

Una vez configurado el repositorio, agregue el JAR de la API de servicio como una dependencia de proyecto en el archivo pom.xml del proyecto.

note note
NOTE
Utilice la misma versión del JAR de API que el paquete de AEM Guides que ha instalado en el servidor.

Configure la dependencia de Maven como se muestra a continuación:

code language-xml
`<dependency> <groupId>com.adobe.fmdita</groupId> <artifactId>api</artifactId> <version>4.0</version> </dependency>`

Una vez agregado el JAR de la API de servicio como dependencia del proyecto en el archivo pom.xml del proyecto, puede generar y utilizar las API de Java de AEM Guides en su proyecto.

Uso del JAR de API del repositorio de Maven Central para AEM Guides as a Cloud Service

Para AEM Guides as a Cloud Service, el JAR de la API se ha implementado en Maven Central. Puede utilizar el JAR de la API sin ninguna configuración.

NOTE

La convención de nombres del JAR de la API se ha actualizado según la convención de nombres de los complementos de la nube.

Para utilizar el JAR de API, debe añadir la dependencia al pom.xml de su proyecto como se muestra a continuación:

<dependency>
   <groupId>com.adobe.aem</groupId>
   <artifactId>aem-guides-sdk-api</artifactId>
   <version>2022.5</version>
</dependency>

NOTE

Dado que los paquetes dentro del JAR de API siguen siendo los mismos, no se requiere ningún cambio de código para utilizar este JAR de API en los proyectos de nube existentes.

Recursos adicionales

A continuación se muestra una lista de otros recursos útiles de AEM Guides, que están disponibles en la página Aprendizaje y asistencia:

Guía del usuario
Guía de instalación y configuración
Guía de inicio rápido
Página de archivo de ayuda (acceder a la documentación de la versión anterior)

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178