差分

このページの2つのバージョン間の差分を表示します。

--- ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2025/11/29 05:47] – [アクセス元による] junichi
+++ ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2026/02/04 08:11] (現在) – [bearer トークンによる認証] junichi
@@ 行 443: / 行 443: @@
 ==== API チェッカー ====
-Access from the Administration menu: **Admin tools** → **API checker**.
+<WRAP left round box 50%>
-管理メニューの **管理ツール(Admin tools)** → **API チェッカー(API checker)** からアクセスします。
+<wrap :en>**Management → {{:wiki:pfms-management-admin_tools-icon.svg?nolink&21x21}} Admin tools → API checker**</wrap> menu.
-{{  :wiki:pfms-admin_tools-api_checker.png  }}
+</WRAP>
+\\ \\ \\ \\ \\
-{{  :wiki:pfms-admin_tools-api_checker-credentials.png  }}
+<WRAP left round box 50%>
-<WRAP center round info 60%>
+<wrap :ja>**管理(Management) → {{:wiki:pfms-management-admin_tools-icon.svg?nolink&21x21}} 管理ツール(Admin tools) → APIチェッカー(API checker)**</wrap> メニュー。
-**Version 768 or later**: You can authenticate with **API Token** by sending in the [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers|HTTP headers]] a [[https://www.rfc-editor.org/rfc/rfc6750#page-3|bearer token]] generated by each user and for their own private and particular use. See "[[:en:documentation:04_using:11_managing_and_administration#user_edition_by_the_user_itself|Edit my user]]" for more details.
+</WRAP>
+\\ \\ \\ \\ \\
-</WRAP>\\
+{{  :wiki:pfms-admin_tools-api_checker_2.png  }}
-<WRAP center round info 60%>
+  * <wrap :en>**Credentials**</wrap>:
-**バージョン 768 以降**: [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers|HTTP ヘッダー]] で各ユーザによって個別に生成され [[https://www.rfc-editor.org/rfc/rfc6750#page-3|bearer トークン]] を送信することにより、**API トークン** で認証することができます。
+  * <wrap :ja>**資格情報**</wrap>:
+<WRAP center round info 90%>
+The <wrap :en>**API password**</wrap>, <wrap :en>**User**</wrap>, and <wrap :en>**Password**</wrap> fields are used to query using user credentials. Starting from PFMS version 768, it is recommended to authenticate using <wrap :en>**API Token**</wrap>, which is sent in the [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers|HTTP headers]] as a //[[https://www.rfc-editor.org/rfc/rfc6750#page-3|bearer token]]// generated by each user for their own private and individual use. See “[[:en:documentation:pandorafms:management_and_operation:11_managing_and_administration#ks1_1_1|Edit my user]]” for more details.
 </WRAP>
-{{  :wiki:pfms-admin_tools-api_checker-call_parameters.png  }}
+<WRAP center round info 90%>
+<wrap :ja>**API パスワード(API password)**</wrap>、<wrap :ja>**ユーザ(User)**</wrap>、および <wrap :ja>**パスワード(Password)**</wrap> フィールドは、ユーザ認証情報を使用してクエリを実行するために使用されます。PFMS バージョン 768 以降では、<wrap :ja>**API トークン(API Token)**</wrap> を使用して認証することが推奨されています。API トークンは、各ユーザが自身のプライベートおよび個人使用のために生成する //[[https://www.rfc-editor.org/rfc/rfc6750#page-3|ベアラートークン]]// として [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers|HTTP ヘッダー]] で送信されます。詳細については、「[[:ja:documentation:pandorafms:management_and_operation:11_managing_and_administration#ks1_1_1|ユーザの編集]]」を参照してください。
+</WRAP>
+The IP address defaults to ''127.0.0.1''. If you want to query using the real IP address of the PFMS Server, you must take into account the [[#ks2_1_1|allowed IP addresses]].
+IPアドレスのデフォルトは ''127.0.0.1'' です。PFMS サーバの実際の IP アドレスを使用してクエリを実行する場合は、[[#ks2_1_1|許可されたIPアドレス]]を考慮する必要があります。
+{{  :wiki:pfms-admin_tools-api_checker-credentials_2.png  }}
+  * <wrap :en>**Call parameters**</wrap>:
+  * <wrap :ja>**呼び出しパラメータ(Call parameters)**</wrap>:
+See the [[#ks2|query syntax]].
+[[#ks2|クエリ書式]]を参照してください。
+{{  :wiki:pfms-admin_tools-api_checker-call_parameters_2.png  }}
+  * <wrap :en>**Custom URL**</wrap>:
+  * <wrap :ja>**カスタム URL(Custom URL)**</wrap>:
+It will display the URL of the query performed. Although it allows editing, the changes will not be applied if the <wrap :en>**Call**</wrap> button is pressed.
+実行されたクエリの URL が表示されます。編集は可能ですが、<wrap :ja>**呼び出し(Call)**</wrap>ボタンを押しても変更は適用されません。
+{{  :wiki:pfms-admin_tools-api_checker-custom_url_2.png  }}
+  * <wrap :en>**Result**</wrap>:
+Returns the result of the query. If an ''auth error'' is obtained, you should review [[#ks2_1_5|the parameters and conditions]].
+クエリの結果を返します。「認証エラー(auth error)」が発生した場合は、[[#ks2_1_5|パラメータと条件]]を確認してください。
+{{  :wiki:pfms-admin_tools-api_checker-result_2.png  }}
-{{  :wiki:pfms-admin_tools-api_checker-custom_url.png  }}
+<wrap #ks2_3 />
 ==== セキュリティ処理の流れ ====
@@ 行 565: / 行 609: @@
   * 接続をデバッグする場合は、''-v'' パラメータを利用します。(バージョンを表示する ''-V'' と混同しないでください。)
+<wrap #ks2_4_2 />
 === 情報取得 ===