intra-mart Accel Platform 履歴・コメントモジュールプログラミングガイド 第3版 2023-10-01

9.1. OAuth認証を利用した外部アプリケーション連携

OAuth認証機能を利用し、外部アプリケーションから履歴・コメントモジュールのREST APIを呼び出す方法を説明します。

コラム

OAuth認証の概要については「OAuth認証モジュール 仕様書」-「概要」を参照してください。

9.1.1. intra-mart Accel Platform上にてクライアントアプリケーションの追加を行う

OAuth 管理者操作ガイド」-「クライアントアプリケーションの登録」を参照し、クライアントアプリケーションの登録を行います。この際、「アクセス範囲」にスコープ「journal」を指定します。
または、設定ファイルを使用してクライアントアプリケーションの登録を行います。
設定ファイルを使用したクライアントアプリケーションの設定の詳細は「設定ファイルリファレンス」-「OAuth認証機能」-「クライアント詳細設定」を参照してください。この場合も同様に「アクセス範囲」にスコープ「journal」を指定してください。

9.1.2. 外部アプリケーションより履歴・コメントモジュールのREST APIのエンドポイントを呼び出す

OAuth プログラミングガイド」-「クライアントアプリケーションからOAuth認証機能を利用する方法」を参照し、クライアントアプリケーションから履歴・コメントモジュールのREST APIのエンドポイントを呼び出します。

コラム

ユーザ(リソースオーナー)によりクライアントアプリケーションからのスコープ「journal」へのアクセスが許可された場合のみ、クライアントアプリケーションより履歴・コメントモジュールのREST APIのエンドポイントを呼び出すことができます。

コラム

履歴・コメントモジュールのREST APIのエンドポイントの詳細は「APIドキュメント」-「履歴・コメントモジュール Rest」を参照してください。
履歴・コメントモジュールのREST APIでは、認証方式により呼び出し先のエンドポイントが異なります。
OAuth認証を使用する場合、パスプレフィックスとして”/api/bearer/journal/...”を使用します。