API クライアント
Version:
日本語翻訳に関する免責事項
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
JavaScript SDK は、API クライアントを使用してサーバーから REST API 情報を取得します。これは次の 2 通りに使用されます。
- 互換性チェックのために API/サーバー バージョンを取得する
- REST API の URL を取得する
API 情報の取得
API 情報の取得
API 情報を取得するには、getApiInfoAsync メソッドを使用します。このメソッドは IApiInfo を返します。このオブジェクトには、サーバー バージョン、サポートされている最小の SDK バージョン、および REST API ルートが含まれています。
これはほとんど常に、JavaScript SDK によって最初に実行される呼び出しです。これらのバージョンと REST API の URL は実行時に変更されないため、この結果はキャッシュされます。どうしても必要な場合は、API クライアントの Refresh メソッドを使用して結果を更新できます。
REST API ルートの取得
REST API ルートの取得
REST API ルートを取得するには、IApiInfo.Routes プロパティまたは API クライアントの getApiRoutesAsync メソッドを使用します。後者は単なるショートカットです。これにより、REST API によってサポートされているルートの読み取り専用ディクショナリが返されます。これは SDK の内部でも使用されます。