CIVIL API を使用するには、ベース URL と API キーを理解することが重要です。
このページを読む前に、次のドキュメントを理解しておくことをお勧めします。
ベースURL
REST API では、baseURL は API エンドポイントのデフォルト URL を表します*。これは、API サーバーとのすべての HTTP リクエストで使用される共通のベース アドレスを定義します。
通常、baseURL は API のルート アドレスとして機能し、このルートに基づいてすべてのエンドポイントの相対アドレスを決定します。たとえば、単純な REST API の例を次に示します。
Base URL: https://api.example.com Endpoints: - /users - /posts - /comments
.この場合、baseURL は https://api.example.com で、エンドポイント”/users”、”/products”、”/orders”はこの baseURL を基準としています。
したがって、ユーザー情報を取得するエンドポイントは https://api.example.com/users になり、投稿情報を取得するエンドポイントは https://api.example.com/posts になります。
baseURL を使用すると、API クライアントはリクエストごとにサーバー アドレスを繰り返すことなく API サーバーと通信できます。これにより、コードが簡素化され、メンテナンスが容易になります。
*エンドポイント: REST API 内の特定のリソースまたはサービスにアクセスするための URL パス。
API キー
API キーは、Web API を使用する開発者またはアプリケーションに認証とアクセス権限を付与するセキュリティ文字列です。これは文字列として提供されます。API 呼び出しを行うクライアントを識別して認証します。主な役割は次のとおりです。
- 認証とアクセス制御：API キーは、API サーバーにリクエストを送信するクライアントを識別して認証します。サーバーは、正しい API キーを持つリクエストのみを受け入れて処理します。
- ユーザー識別：API キーを通じて、どのユーザーまたはアプリケーションが API を使用しているかを識別することができます。これは、ログ記録、分析、および使用状況の追跡に役立ちます。
- アクセス制御と権限管理：API キーは、クライアントのアクセス レベルの管理と権限の割り当てに役立ちます。API キーにより、さまざまな API エンドポイントまたは機能に対する制限や承認が可能になります。
- セキュリティ対策：API キーは、API の悪用に対する追加のセキュリティ レイヤーとして機能します。パブリック API の場合、API キーが公開されると、サーバー側またはクライアント側で API の悪用や不正使用を防ぐための対策が講じられる可能性があります。
API キーは通常、HTTP リクエスト ヘッダーまたはリクエスト パラメータに含まれます。たとえば、リクエストに API キーを含める一般的な方法は次のとおりです。
API キーを含める：
- ヘッダー内：API キーを HTTP リクエスト ヘッダーで渡します (多くの場合、Authorization ヘッダーまたはカスタム ヘッダーとして渡します)。
- リクエストパラメータ内：リクエスト時に、URL クエリ文字列に API キーを含めます。
API キーには機密情報が含まれているため、安全に保存して送信することが重要です。API キーの生成と管理に関して、API サービス プロバイダーが提供するガイドラインに従うことも良い考えです。
CIVIL API のベース URL と API キー
CIVIL API は、ベース URL と API キーの概念の両方を利用します。
ベース URL は、製品の使用状況、国、またはサーバーに応じて異なる場合があります。以下の製品パスに基づいて確認できます。
CIVIL API では MAPI キーと呼ばれる API キーは、REST API 応答を要求するときにヘッダーに含める必要があります。したがって、機能を有効にするには、対応する製品キー値とともにキー”MAPI キー”をヘッダーに追加することが不可欠です。これは、ベース URL に類似した以下の製品パスに基づいて確認できます。
設定例
MAPI キーを変更できるのはなぜですか?
MAPI キーは、サーバーに接続する特定の MIDAS 製品を識別する重要なパラメータです。ユーザーの PC またはネットワーク環境によっては、製品またはユーザーごとに固定値を割り当てると、セキュリティ上の脅威となる可能性があります。
キーが侵害された場合、ユーザーの製品がリモート制御される可能性があるというリスクがあります。ランダムに生成された一時キーは、MAPI キーの概念の代替として使用できます。