はじめに id1761C0007W7

Adobe Experience Manager Guides \(後で​AEM Guides\と呼ばれます)は、Adobe Experience Manager \(AEM\)がDITA ベースのコンテンツの作成と配信に対応するコンポーネントコンテンツ管理ソリューション \(CCMS\)機能を持つことを可能にする、エンドツーエンドのエンタープライズソリューションです。 お客様は、AEM Guides APIを使用してAEM Guides ワークフローにプログラムでアクセスし、他のエンタープライズアプリケーションと統合できます。 これらのAPIは、Adobeパートナーが機能を拡張したり、他のアプリケーションやサービスと統合したりすることで、AEM Guidesの価値提案を強化するためにも使用できます。

AEM GUIDES API

AEM Guides APIには、次の2つの形式があります。

これらのAPIは、AEM Guidesの主要な機能をアプリケーション開発者に公開します。 これらの機能を使用して、開発者は独自のプラグインを作成し、すぐに使用できるワークフローを拡張できます。 APIは、DITA コンテンツの出力の管理、DITA マップの操作、フォルダーレベルのプロファイルへの条件付き属性の追加、HTMLおよびWords ドキュメントのDITA フォーマットへの変換に関して使用できます。

Java ベースのAPI

Experience Manager Guidesで利用可能なJava ベースのAPIを使用して、カスタムプラグインを作成し、すぐに利用できるワークフローを拡張できます。

AEM Guides as a Cloud ServiceのMaven中央リポジトリからSDKを設定

INFO
Experience Manager Guides as a Cloud Service用のJava ベース APIの使用に関する最新の詳細なドキュメントについては、 javadoc をご覧ください。

Maven リポジトリのサービス API JARをプロジェクトで設定して使用するには、以下に示すように、API SDKをプロジェクトのpom.xml ファイルにプロジェクト依存関係として追加します。

<dependency>
<groupId>com.adobe.aem</groupId>
<artifactId>aem-dox-sdk-api</artifactId>
<version>${RELEASE}</version>
</dependency>
NOTE
サーバーにインストールされているAEM Guides パッケージと同じバージョンのAPI JARを使用していることを確認してください。

Maven中央リポジトリ(オンプレミス)からAPI JARを設定して使用する

INFO
Experience Manager Guides オンプレミス設定にJava ベースのAPIを使用する方法に関する最新の詳細なドキュメントについては、 javadoc を参照してください。

オンプレミスのデプロイメント用にサービス API JARを設定して使用するには、次に示すように、サービス API JARをプロジェクトのpom.xml ファイルのプロジェクト依存関係として追加します。

<dependency>
<groupId>com.adobe.aem</groupId>
<artifactId>aem-guides-sdk-api</artifactId>
<version>${RELEASE}</version>
</dependency>
NOTE
サーバーにインストールされているAEM Guides パッケージと同じバージョンのAPI JARを使用していることを確認してください。

AEM Guidesのパブリック Maven リポジトリ(オンプレミス)からAPI JARを設定して使用する

NOTE
公開されたAEM Guides Maven リポジトリは、Experience Manager Guidesの5.3.0 リリース後に非推奨(廃止予定)になります。 API JARは、それ以降はMaven中央リポジトリでのみ使用できます。

パブリック Maven リポジトリからサービス API JARを使用するには、次の手順を実行します。

  1. 次に示すように、pom.xmlまたはsettings.xml ファイルでAEM Guides パブリック Maven リポジトリを設定します。

    code language-xml
    <repository>
        <id>fmdita-public</id>
        <name>fmdita-public</name>
        <url>https://repo.aem-guides.com/repository/fmdita-public</url>
     </repository>
    
  2. リポジトリを設定したら、プロジェクトのpom.xml ファイルにプロジェクト依存関係としてサービス API JARを追加します。

    code language-xml
    <dependency>
        <groupId>com.adobe.fmdita</groupId>
        <artifactId>api</artifactId>
        <version>${RELEASE}</version>
    </dependency>
    
    note
    NOTE
    サーバーにインストールしたAEM Guides パッケージと同じバージョンのAPI JARを使用します。

プロジェクトのpom.xml ファイルにサービス API JARがプロジェクト依存関係として追加されたら、プロジェクトでAEM Guides Java APIを構築して使用できます。

REST ベースのAPI

Experience Manager Guidesには、開発者がHTTP経由でコア機能にアクセスして操作できる、包括的なREST ベースのAPI セットが用意されています。

これらのAPIは、次のような場合に最適です。

  • Experience Manager Guidesの統合
  • 公開ワークフローとレビューワークフローの自動化
  • カスタムアプリケーションや拡張機能の構築

APIの使用状況、パラメーター、リクエストの例について詳しくは、Experience Manager Guides ドキュメントの​API リファレンス セクションの関連トピックを参照してください。

その他のリソース

以下は、​ ラーニングとサポート ​ ページで入手できるAEM Guidesのその他の役立つリソースの一覧です。

  • ユーザーガイド
  • インストールおよび設定ガイド
  • クイックスタートガイド
  • ​ ヘルプアーカイブページ ​ \(以前のリリースドキュメントにアクセス\)
recommendation-more-help
experience-manager-guides-help-product-guide