はじめに
URL APIとは?
URL APIは、eセールスマネージャーの特定の画面に、他のシステムやアプリケーションから直接アクセスできる仕組みです。
専用のURLを生成・活用することで、eセールスマネージャーの画面を外部システムからシームレスに呼び出すことが可能となり、eセールスマネージャーと他サービスとの連携を実現できます。
URL APIの利用に必要な知識
URL APIの利用には以下の基本知識が必要です。
- eセールスマネージャーの基本的な使い方の知識
- URLのクエリ文字列に関する基本的な知識
- クエリ文字列について
各アプリのオプションを使用する際には以下の表を参考にクエリ文字列を生成してください。
ただし、「#」から始まるオプションについては以下のものを使用しないでください。
- クエリ文字列について
記号 | 役割 | 例 |
---|---|---|
? | クエリ文字列の開始を表す | ?entityId={id} |
& | 複数のクエリパラメータをつなぐ | ?mainDisplayTarget=employee-1&additionalDisplayTarget=employee-2 |
認証について
URL APIのログイン認証については以下の通りです。
- 未ログイン状態であるとき
対象画面のURLにアクセスすると自動的にログイン画面に遷移します。
ログインが完了すると、対象画面に遷移します。 - ログイン状態が保持されているとき
対象画面のURLにアクセスするとログイン画面を経由することなく、対象画面に遷移します。
プラン
eセールスマネージャーをご契約中のお客様は、どなたでもご利用いただけます。