2022年1月20日 (木) 07:35時点における最新版

このドキュメントではユーザがサービスにアクセスできるよう管理者がウェブサービスを設定する方法を説明します。サービスにアクセスするため、それぞれのユーザには特定およびユニークなセキュリティキー (「トークン」として知られています) があります。

ウェブサービスを有効にする

「設定 > サイト管理 > 拡張機能」に移動してください。
「ウェブサービスを有効にする」をチェックした後、「変更を保存する」ボタンをクリックしてください。

注意: セキュリティ上の理由から、あなたが使用したい場合のみ、ウェブサービスを有効にしてください。

プロトコルを有効にする

通常、ユーザが使用したい外部アプリケーションの使用するプロトコルを有効にすべきです。

「管理 > サイト管理 > プラグイン > ウェブサービス > プロトコル管理」に移動してください。
必要に応じて、プロトコル (SOAP, REST, XMLRPC, AMF, ...) を有効にしてください。

ウェブサービス関数ドキュメンテーションを有効にする

セキュリティキーページのドキュメンテーションリンク

プロトコル管理ページでウェブサービス関数ドキュメンテーションを有効にすることにより、それぞれのユーザはセキュリティキーページでユーザ固有のウェブサービスドキュメンテーションを利用できるようになります。このオプションは主にウェブサービスクライアント開発者に有用です。ウェブサービスクライアントを誰も作成していない場合、この機能を有効にする必要はありません。

サービスを作成する

あなたの要求に事前構築のウェブサービスが合致しない場合、カスタムサービスを作成できます。例) そのサービス経由でどのような標準ウェブサービス関数が利用できるか選択してください。

あなたが露出する必要のある特定の関数のみ有効にできます。そのため、セキュリティ上の危険にさらされることはありません。

サービスを作成する

「管理 > サイト管理 > プラグイン > ウェブサービス > 外部サービス」にアクセスしてください。
「追加」リンクをクリックしてください。
- 認証済みユーザのみ - 有効にした場合、あなたは手動で認証ユーザを選択する必要があります。そうでない場合、そうでない場合、適切なパーミッションのユーザすべてが許可されます。
- 必須ケイパビリティ - 有効にした場合、ウェブサービスにアクセスするユーザすべてに対して、この選択されたケイパビリティがチェックされます (これは任意の追加セキュリティレイヤです)。
名称を入力して有効にしてください。
「サービスを追加する」ボタンをクリックしてください。

サービスに関数を追加する

現在、あなたのサービスは空であり何もできません。ウェブサービス関数を追加する必要があります。外部アプリケーションで何を許可するかにより、あなたの選択は決定します。例えば「グループを作成する」を選択した場合:

「関数を追加する」リンクをクリックしてください。
「グループを作成する」を選択して「関数を追加する」ボタンをクリックしてください。

あなたはサービス関数一覧に戻っていることでしょう。それぞれの関数において「必須ケイパビリティ」が表示されています。ユーザは関数を実行するためのケイパビリティを必要とします。関数説明内のAPIドキュメンテーションにより必須ケイパビリティに関して詳細情報を閲覧できます (設定 > サイト管理 > 設定 > サイト管理 > プラグイン > ウェブサービス > APIドキュメンテーション)。

ケイパビリティを有効にする

最後のステップでは適切なパーミッションを付与します。以下のケイパビリティを許可してください:

moodle/webservice:createtoken - ユーザがセキュリティキーを生成できるようにするため。
webservice/rest:use, webservice/soap:use, webservice/xmlrpc:use, webservice/amf:use - 有効にされたプロトコルに合致します。
設定されている場合、サービス「必須ケイパビリティ」 (管理 > サイト管理 > プラグイン > ウェブサービス > 外部サービス > 「編集」リンク)。
ウェブサービス関数に必要なケイパビリティ。あなたがサービスに関数を追加する場合、これらの必須ケイパビリティが一覧表示されます。ロールおよびケイパビリティに関する詳細はロールの管理ドキュメンテーションをご覧ください。

前述の作業によりウェブサービスの準備が整います。ユーザがセキュリティーキーを取得できるようになります。

代替設定

特定ユーザのみ認証する

「設定 > サイト管理 > プラグイン > ウェブサービス > 外部サービス」
「認証済みユーザ」リンクをクリックしてください (サービスには「編集」リンク経由で「認証ユーザのみ」を設定される必要があります)。
ユーザを選択した後、「追加」をクリックしてください。

認証済みユーザに割り当てるケイパビリティが必要な場合、Moodleはその旨を表示します。さらに認証ユーザのフルネームをクリックした場合、あなたはいくつかのオプションを設定できます:「IP制限および有効期限」

トークンを作成する

この機能はあなたが特定のユーザにトークンを作成できるようにします。これはユーザに「moodle/create:token」ケイパビリティがない場合に有用です。これは管理者がトークンを作成できる唯一の方法でもあります。セキュリティ上の理由からトークンは管理者セキュリティキーページで自動的に生成されません。

「設定 > サイト管理 > プラグイン > ウェブサービス > トークンを管理する」に移動してください。
「追加」をクリックしてください。
作成されたユーザおよびサービスを選択してください。
「変更を保存する」をクリックしてください。

このユーザにトークンを作成した場合、あなたはユーザに対して「moodle/webservice:createtoken」を割り当てる必要はありません。最後に認証ユーザに対して、あなたがトークンの「IPアドレス制限」および「有効期限」を設定できることに留意してください。

@@ 1行目: / 1行目: @@
 {{ウェブサービス}}
-作成中です - [[利用者:Mitsuhiro Yoshida|Mitsuhiro Yoshida]] ([[利用者・トーク:Mitsuhiro Yoshida|トーク]])
+このドキュメントではユーザがサービスにアクセスできるよう管理者がウェブサービスを設定する方法を説明します。サービスにアクセスするため、それぞれのユーザには特定およびユニークなセキュリティキー (「トークン」として知られています) があります。
-This document explains how an administrator can set up a web service for users to access a service. Each user will have a specific and unique security key (also known as a "token") to access the service.
+== ウェブサービスを有効にする==
-== ウェブサービスを有効にする==
+[[Image:Enable_web_service.png|thumb|ウェブサービスを有効にする]]
-[[Image:Enable_web_service.jpg|thumb|Enabling web services]]
-# 「設定 > サイト管理 > 拡張機能」にアクセスしてください。
+# 「設定 > サイト管理 > 拡張機能」に移動してください。
-# Check 'Enable web services' then click 'Save Changes'
+# 「ウェブサービスを有効にする」をチェックした後、「変更を保存する」ボタンをクリックしてください。
-Note: For security reasons, web services should only be enabled if you intend to make use of it.
+注意: セキュリティ上の理由から、あなたが使用したい場合のみ、ウェブサービスを有効にしてください。
 == プロトコルを有効にする ==
-[[Image:Enable_protocol.jpg|thumb|left|Enabling protocols]]
+[[Image:Enable_protocol.png|thumb|thumb|プロトコルを有効にする]]
-Usually external applications that users wish to use dictate which protocols should be enabled.
-# Access ''Settings > Site administration > Plugins > Web services > Manage protocols''
+通常、ユーザが使用したい外部アプリケーションの使用するプロトコルを有効にすべきです。
-# Enable the protocols (SOAP, REST, XMLRPC, AMF, ...) as required
+# 「管理 > サイト管理 > プラグイン > ウェブサービス > プロトコル管理」に移動してください。
+# 必要に応じて、プロトコル (SOAP, REST, XMLRPC, AMF, ...) を有効にしてください。
 == ウェブサービス関数ドキュメンテーションを有効にする ==
-[[Image:Security keys and documentation.jpg|thumb|Security keys page with documentation link]]
+[[Image:Security keys and documentation.png|thumb|セキュリティキーページのドキュメンテーションリンク]]
-Enabling web service function documentation (also on the Manage protocols page) results in user-specific web service documentation being available for each user on their [[Security keys]] page. This option is mainly useful to web service client developers. If nobody is creating a web service client, there is no need to enable this feature.
+プロトコル管理ページでウェブサービス関数ドキュメンテーションを有効にすることにより、それぞれのユーザは[[セキュリティキー]]ページでユーザ固有のウェブサービスドキュメンテーションを利用できるようになります。このオプションは主にウェブサービスクライアント開発者に有用です。ウェブサービスクライアントを誰も作成していない場合、この機能を有効にする必要はありません。
-== サービスの作成 ==
+== サービスを作成する ==
-If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.
+あなたの要求に事前構築のウェブサービスが合致しない場合、カスタムサービスを作成できます。例) そのサービス経由でどのような標準ウェブサービス関数が利用できるか選択してください。
-You can enable only the specific functions that you need to expose, so not compromising on security.
+あなたが露出する必要のある特定の関数のみ有効にできます。そのため、セキュリティ上の危険にさらされることはありません。
-[[Image:Create a service.jpg|thumb|Creating a service|left]]
+[[Image:Create a service.png|thumb|サービスを作成する]]
-# Access ''Settings > Site administration > Plugins > Web services > External services''
+#「管理 > サイト管理 > プラグイン > ウェブサービス > 外部サービス」にアクセスしてください。
-# Click Add new custom service
+#「追加」リンクをクリックしてください。
-#* 'Authorised users only' - If enabled, you will need to select the authorised users manually. Otherwise all users with appropriate permissions are allowed
+#* 認証済みユーザのみ - 有効にした場合、あなたは手動で認証ユーザを選択する必要があります。そうでない場合、そうでない場合、適切なパーミッションのユーザすべてが許可されます。
-#* 'Required capability' - If enabled, any user accessing the web service will be checked against this selected capability. (This is just an additional optional security layer.)
+#* 必須ケイパビリティ - 有効にした場合、ウェブサービスにアクセスするユーザすべてに対して、この選択されたケイパビリティがチェックされます (これは任意の追加セキュリティレイヤです)。
-# Enter a name and check Enabled
+# 名称を入力して有効にしてください。
-# Click the button 'Add service'
+# 「サービスを追加する」ボタンをクリックしてください。
 ==サービスに関数を追加する==
-[[Image:Select a web service function.jpg|thumb|Adding functions to the service]]Your service is currently empty and doesn't do anything. Web service functions need to be added. Your choice will be dictated by what you allow the external application to do. For this example, select 'Create group'.
+[[Image:Select_a_web_service_function.png|thumb|サービスに関数を追加する]]現在、あなたのサービスは空であり何もできません。ウェブサービス関数を追加する必要があります。外部アプリケーションで何を許可するかにより、あなたの選択は決定します。例えば「グループを作成する」を選択した場合:
-# Click 'Add functions' link
-# Select 'create group' function and click the 'Add functions' button
-You should be back to the service functions list. 'Required capabilities' are indicated for each function. Users need the required capabilities to run a function. The function descriptions in the API Documentation can also give you more information about the required capabilities (''Settings > Site administration > Plugins > Web services > API Documentation'').
+# 「関数を追加する」リンクをクリックしてください。
+# 「グループを作成する」を選択して「関数を追加する」ボタンをクリックしてください。
-==Enabling capabilities==
+あなたはサービス関数一覧に戻っていることでしょう。それぞれの関数において「必須ケイパビリティ」が表示されています。ユーザは関数を実行するためのケイパビリティを必要とします。関数説明内のAPIドキュメンテーションにより必須ケイパビリティに関して詳細情報を閲覧できます (設定 > サイト管理 > 設定 > サイト管理 > プラグイン > ウェブサービス > APIドキュメンテーション)。
-The final step is to grant appropriate permissions. The following capabilities should be allowed:
+==ケイパビリティを有効にする==
-* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - for allowing users to generate a security key
+最後のステップでは適切なパーミッションを付与します。以下のケイパビリティを許可してください:
-* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] which match the enabled protocols.
-* The service ''Required capability'' if set (''Settings > Site administration > Plugins > Web services > Manage services >'''Edit''' link'').
-* The required capabilities for the web service functions. These required capabilities are listed when you add a function to the service. For more information about roles and capabilities, read the [[Manage roles]] documentation.
-Once done, the web service should be set up. Users should be able to [[Security keys|obtain a personal security key]].
+* [[Capabilities/moodle/webservice:createtoken|moodle/webservice:createtoken]] - ユーザがセキュリティキーを生成できるようにするため。
+* [[Capabilities/webservice/rest:use | webservice/rest:use]], [[Capabilities/webservice/soap:use | webservice/soap:use]], [[Capabilities/webservice/xmlrpc:use | webservice/xmlrpc:use]], [[Capabilities/webservice/amf:use | webservice/amf:use]] - 有効にされたプロトコルに合致します。
+* 設定されている場合、サービス「必須ケイパビリティ」 (管理 > サイト管理 > プラグイン > ウェブサービス > 外部サービス > 「編集」リンク)。
+* ウェブサービス関数に必要なケイパビリティ。あなたがサービスに関数を追加する場合、これらの必須ケイパビリティが一覧表示されます。ロールおよびケイパビリティに関する詳細は[[ロールの管理]]ドキュメンテーションをご覧ください。
-= Alternative settings =
+前述の作業によりウェブサービスの準備が整います。ユーザが[[セキュリティキー|セキュリティーキーを取得できるようになります]]。
-== Authorise only specific users==
+= 代替設定 =
-[[Image:Authorised users link.jpg|thumb]] [[Image:Authorised user selection page.jpg|thumb]]
+== 特定ユーザのみ認証する==
-# ''Settings > Site Administration > Plugins > Web services > External Services''
+[[Image:Authorised_users_link.png|thumb]] [[Image:Authorised user selection page.png|thumb]]
-# Select '''Authorised users''' link (the service must have been set as '''Authorised users only''' in the '''Edit''' link)
+# 「設定 > サイト管理 > プラグイン > ウェブサービス > 外部サービス」
-# Select some users and click '''Add'''
+# 「認証済みユーザ」リンクをクリックしてください (サービスには「編集」リンク経由で「認証ユーザのみ」を設定される必要があります)。
+# ユーザを選択した後、「追加」をクリックしてください。
-Moodle indicates if some capabilities need to be assigned to an authorised user. Moreover if you click on the authorised user fullname, you can set up some specific options: ''IP restriction'' and ''Valid until''.
+認証済みユーザに割り当てるケイパビリティが必要な場合、Moodleはその旨を表示します。さらに認証ユーザのフルネームをクリックした場合、あなたはいくつかのオプションを設定できます:「IP制限および有効期限」
-== Create a token  ==
+== トークンを作成する  ==
-[[Image:Create_token.jpg|thumb]]
+[[Image:Create_token.png|thumb]]
-This feature allows you to create a token for specific user. It can be useful if a user doesn't have the moodle/create:token capability. This is also the only way to create a token for an administrator. For security reason, tokens are not automatically generated in the administrator security  keys page.
+この機能はあなたが特定のユーザにトークンを作成できるようにします。これはユーザに「moodle/create:token」ケイパビリティがない場合に有用です。これは管理者がトークンを作成できる唯一の方法でもあります。セキュリティ上の理由からトークンは管理者セキュリティキーページで自動的に生成されません。
-# ''Settings > Site Administration > Plugins > Web services > Manage tokens''
+# 「設定 > サイト管理 > プラグイン > ウェブサービス > トークンを管理する」に移動してください。
-# Click on '''Add'''
+# 「追加」をクリックしてください。
-# Select the created user and service
+# 作成されたユーザおよびサービスを選択してください。
-# Click on '''Saves changes'''
+# 「変更を保存する」をクリックしてください。
-As you created a token for this user, you do not need to assign "''moodle/webservice:createtoken''" to him/her.
+このユーザにトークンを作成した場合、あなたはユーザに対して「moodle/webservice:createtoken」を割り当てる必要はありません。最後に認証ユーザに対して、あなたがトークンの「IPアドレス制限」および「有効期限」を設定できることに留意してください。
-Finally, note that, as for authorised users, you can also set ''IP restriction'' and ''Valid until'' on a token.
 == 関連情報 ==
-*[http://www.joomdle.com/wiki/Preparing_Moodle_20#Setting_up_Moodle_Web_services Joomdle documentation about setting Moodle web services]
+*[http://www.joomdle.com/wiki/Preparing_Moodle_20#Setting_up_Moodle_Web_services Moodleウェブサービスの設定に関するJoomdleドキュメンテーション]
 [[en:How_to_create_and_enable_a_web_service]]

Documentation

「ウェブサービスを使用する」の版間の差分

2022年1月20日 (木) 07:35時点における最新版

目次

ウェブサービスを有効にする

プロトコルを有効にする

ウェブサービス関数ドキュメンテーションを有効にする

サービスを作成する

サービスに関数を追加する

ケイパビリティを有効にする

代替設定

特定ユーザのみ認証する

トークンを作成する

関連情報