Joomla カスタム API 拡張機能設定ガイド

概要

当学校区の カスタムAPI拡張 Joomla CMS（コンテンツ管理システム）の機能を拡張するためのカスタムAPIを作成できます。これらのAPIを使用することで、 Joomlaウェブサイトから特定の機能やデータを公開する外部プログラムやサービスがJoomlaウェブサイトと通信できるようにします。このプラグインは、独自に開発したカスタムエンドポイントを利用してJoomlaデータベースをスムーズに操作する方法を提供し、簡単に実行できます。 CRUD（作成、読み取り、更新、削除） 操作。

プラグインのダウンロード 料金プラン 無料試用版

ステップ1: カスタムAPI拡張機能のインストール

• zip ファイルをダウンロードします。 miniOrangeカスタムAPI拡張 Joomla については上記のリンクから。
• Joomla サイトにログインします。 管理者 コンソール。
• 左側のトグルメニューから、 をクリックします システム、次に インストールを開始する セクションをクリック 拡張機能.

• ここをクリックしてください ファイルを参照 ボタンをクリックして、先ほどダウンロードした拡張機能ファイルを見つけてインストールします。

• プラグインのインストールが成功したら。 今すぐクリックしてください JoomlaカスタムAPIプラグインの使用を開始する.

ステップ2: カスタムAPIを作成する

• GET
• POST
• PUT
• DELETE

GET APIを使用する理由

• Joomlaサイトからデータや情報を取得したい場合は、GET APIを作成できます。プラグインを使用すれば、GET APIに複数のフィルターや条件を追加できます。
• APIにGETリクエストを行う際、URLにパラメータまたはクエリ文字列を指定して、Joomlaサイトから取得したいデータを指定できます。Joomla Custom APIプラグインはリクエストを処理し、要求されたデータをレスポンスで返します。

カスタム GET API を作成するための設定手順

• まず、 カスタムAPI/SQLを作成する タブには何も表示されないことに注意してください。
• 以下を行うには、 詳細 新しい API を作成するためのボタン。

• 入力 API名 ドロップダウンからGET APIメソッドを選択します。そして APIを作成する

APIの詳細を設定する

• パラメータの使用
• API タイプを選択します: パラメータ別.
• 次に、データ取得アクションを実行するテーブル名を選択します。
• このAPIの列とフィルターを選択するための複数のオプションが表示されます。Joomlaサイトからデータを取得するテーブルの列を指定してください。ここで複数の列を選択できます。
• 要件に応じて適切な条件とフィルターを選択するか、条件を指定しないことも可能です。複数のWHERE条件を追加してデータを絞り込む場合は、「+」ボタンをクリックします。条件またはフィルターを削除するには、「-」ボタンをクリックします。
• をオンにする 認証を有効にする API エンドポイントで認証を有効にする場合は、このオプションを選択します。 (API 認証の設定方法については、手順 3 を参照してください。)
• APIを設定したら、 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

• カスタムSQL APIの使用
• API タイプを選択します: カスタムSQL API.
• API呼び出しが成功した際に実行するカスタムSQLクエリを記述します。例:

SELECT * FROM #__users WHERE id='{{id_param}}' AND email='{{email_param}}'; パラメータ名には必ず _ が必要です。



• 以下を行うには、 Save カスタム API を作成するためのボタン。

POST APIを使用する理由

• Joomla サイトにデータを送信してサイト上にリソースを作成する場合は、POST API を使用できます。
• APIにPOSTリクエストを送信する際、リクエスト本文にデータ（通常はJSON形式またはフォームエンコード形式）を送信します。Joomla Custom APIプラグインはデータを処理し、リクエストで提供された情報に基づいて必要なアクションを実行します。

カスタムPOST APIを作成するための設定手順

• まず、 カスタムAPI/SQLを作成する タブには何も表示されないことに注意してください。
• 以下を行うには、 詳細 新しい API を作成するためのボタン。

• 入力 API名 ドロップダウンからPOST APIメソッドを選択します。 APIを作成する

APIの詳細を設定する

• パラメータの使用
• API タイプを選択します: パラメータ別.
• 次に、データ作成アクションを実行するテーブル名を選択します。
• 列を選択するための複数のオプションが表示されます。Joomlaサイトからデータを取得するテーブルの列を指定してください。ここで複数の列を選択できます。
• まず ボディデータ形式 ドロップダウンから、ヘッダーにデータを送信する場所を選択します。
• をオンにする 認証を有効にする API エンドポイントで認証を有効にする場合は、このオプションを選択します。 (API 認証の設定方法については、手順 3 を参照してください。)
• APIを設定したら、 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

• カスタムSQL APIの使用
• API タイプを選択します: カスタムSQL API.
• チェックボックスをオンにすることで、すべてのパラメータを必須にすることができます。この機能では、API呼び出しですべての顧客パラメータを渡す必要があります。
• API呼び出しが成功した際に実行するカスタムSQLクエリを記述します。例:

#__users (id、name、username、email、registerDate、params) に VALUES '{{id}}'、'{{name}}'、'{{username}}'、'{{email}}'、'{{registerDate}}'、'{{params}}' を挿入します。



• 以下を行うには、 Save カスタム API を作成するためのボタン。

PUT APIを使用する理由

• Joomla サイト上の既存のリソースを更新または置き換える場合は、PUT API を作成できます。
• APIにPUTリクエストを送信する際、パラメータ、クエリ文字列、またはリクエスト本文にデータを送信し、リクエストURLで識別されるリソースの表現全体を置き換えます。Joomla Custom APIプラグインはデータを処理し、それに応じてリソースを更新します。

カスタムPUT APIを作成するための設定手順

• まず、 カスタムAPI/SQLを作成する タブには何も表示されないことに注意してください。
• 以下を行うには、 詳細 新しい API を作成するためのボタン。

• 入力 API名 ドロップダウンからPUT APIメソッドを選択します。 APIを作成する

APIの詳細を設定する

• パラメータの使用
• API タイプを選択します: パラメータ別.
• 次に、新しいデータを入力するテーブル名を選択します。
• 次に、API 呼び出しを使用して更新する列を選択します。
• 要件に応じて適切な条件を選択するか、条件を指定しないことも可能です。複数のWHERE条件を追加してデータを絞り込みたい場合は、「+」ボタンをクリックしてください。条件を削除するには、「-」ボタンをクリックしてください。
• クエリパラメータとして、またはリクエストの本文内でデータを渡す柔軟性があります。
• 必ず、key=パラメータ名（リクエスト形式と適用条件の表に記載）と value=特定の要件に従った形式を使用してデータを渡してください。
• 上記の例のユーザー エントリを更新するには、次の手順に従う必要があります。
• URL を入力します: '{joomla_base_url}/api/index.php/v1/mini/custom_put'。
• 次に、PUT HTTP メソッドを選択します。
• リクエストの本文に、名前、ユーザー名、param_1、param_2 のデータを渡します (クエリ形式でも渡すことができます)。
• テーブル内のデータが正常に更新された場合、応答で 1 を受け取ります。

• カスタムSQL APIの使用
• API タイプを選択します: カスタムSQL API.
• API呼び出しが成功した際に実行するカスタムSQLクエリを記述します。例:

UPDATE #__users set username='{{username}}' where id='{{id}}';



• 以下を行うには、 Save カスタム API を作成するためのボタン。

DELETE APIを使用する理由

• Joomla サイト上の特定のリソースを削除する場合は、DELETE API を作成できます。
• APIにDELETEリクエストを行う際、URLまたはリクエスト本文にパラメータまたはクエリ文字列を指定して、Joomlaサイトから削除したいデータを指定できます。Joomla Custom APIプラグインはデータを処理し、それに応じてリソースを更新します。

カスタム DELETE API を作成するための設定手順

• まず、 カスタムAPI/SQLを作成する タブには何も表示されないことに注意してください。
• 以下を行うには、 詳細 新しい API を作成するためのボタン。

• 入力 API名 ドロップダウンからDELETE APIメソッドを選択します。 APIを作成する

APIの詳細を設定する

• パラメータの使用
• API タイプを選択します: パラメータ別.
• 次に、データ削除アクションを実行するテーブル名を選択します。
• 要件に応じて適切な条件を選択するか、条件を指定しないことも可能です。複数のWHERE条件を追加してデータを絞り込みたい場合は、「+」ボタンをクリックしてください。条件を削除するには、「-」ボタンをクリックしてください。
• をオンにする 認証を有効にする API エンドポイントで認証を有効にする場合は、このオプションを選択します。 (API 認証の設定方法については、手順 3 を参照してください。)
• APIを設定したら、 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

• カスタムSQL APIの使用
• API タイプを選択します: カスタムSQL API.
• API呼び出しが成功した際に実行するカスタムSQLクエリを記述します。例:

#__users WHERE id='{{id}}'; から削除します。



• 以下を行うには、 Save カスタム API を作成するためのボタン。

ステップ3: API認証を構成する

• ベアラートークン
• 基本認証
• ＡＰＩキー
• JWT認証

ベアラートークン認証:

クライアントが Authorization ヘッダーで Bearer トークンを送信する、シンプルなトークンベースの認証。

• まず、 認証を有効にする ボタンの APIの詳細を設定する のセクションから無料でダウンロードできます。
• 認証の構成 メニューを選択 ベアラートークン ドロップダウン メニューから選択します。
• 以下を行うには、 トークンの生成 ボタンを押すと、安全なランダムトークンが自動的に作成されます。例： 7c4a8d09ca3762af61e59520943dc26494f8941b
• 「設定を保存」をクリックして、ベアラートークンの設定を適用します。トークンはデータベースに安全に保存されます。

API の使用法:

• API リクエストにトークンを含めます。

Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b



• 次の cURL コマンドを使用して、ベアラー トークンをテストします。

```バッシュ
curl -X GET "https://yoursite.com/api/endpoint" \
-H "認証: Bearer your_token_here" \
-H "コンテンツタイプ: application/json"

Postman を使用して認証をテストします。

• Postman を開きます。
• リクエストメソッドとURLを設定します。
• 次に、「認証」タブに移動します。
• 「ベアラートークン」タイプを選択します。
• 次に、「トークン」フィールドにトークンを入力します。

基本認証（Joomla ユーザー認証）:

Base64 でエンコードされ、Authorization ヘッダー経由で送信される既存の Joomla ユーザー資格情報 (ユーザー名/パスワード) を使用します。

• まず、 認証を有効にする ボタンの APIの詳細を設定する のセクションから無料でダウンロードできます。
• 認証の構成 メニューを選択 基本認証 ドロップダウン メニューから選択します。
• 追加の設定は必要ありませんが、ユーザーは Joomla ユーザー データベースに存在している必要があります。
• 最後に、 構成の保存

API の使用法:

• API リクエストに Joomla のユーザー名/パスワードを含める:

ヘッダー: 認証: Basic base64(ユーザー名:パスワード)



• 次の cURL コマンドを使用して Basic 認証をテストします。

```bash curl -X GET "https://yoursite.com/api/endpoint" \
-H "認証: 基本 $(echo -n 'user:pass' | base64)" \
-H "コンテンツタイプ: application/json"

Postman を使用して認証をテストします。

• Postman を開きます。
• リクエストメソッドとURLを設定します。
• 次に、「認証」タブに移動します。
• 「基本認証」タイプを選択します。
• Joomla のユーザー名とパスワードを入力します。

API キー認証 (Joomla ユーザー認証):

APIキーを使用したヘッダーベースの認証。ユニバーサルキー（全ユーザー共通の単一キー）とユーザーベースキー（ユーザーごとに個別のキー）の両方をサポートします。

• まず、 認証を有効にする ボタンの APIの詳細を設定する のセクションから無料でダウンロードできます。
• 認証の構成 メニューを選択 ＡＰＩキー ドロップダウン メニューから選択します。
• 今選択してください APIキーの種類.
• ユニバーサル API キーの場合:
• 選択する ユニバーサルAPIキー ラジオボタン。
• クリック ユニバーサルAPIキーを生成する
• すべてのAPIアクセスに対して単一のAPIキーが生成されます。例： uk_7c4a8d09ca3762af61e59520943dc26494f8941b
• ユーザーベースの API キーの場合:
• 選択する ユーザーベースのAPIキー ラジオボタン。
• 既存のすべての Joomla ユーザーのキーを生成します。 詳しくはこちら すべてのユーザーのAPIキーを生成するすべてのアクティブな Joomla ユーザーに対してキーが作成されます。
• 特定のユーザーのキーを生成します: 「ユーザー名」欄にユーザー名を入力します。クリック ユーザーのAPIキーを生成する.
• 詳しくはこちら 構成の保存 API キー設定を適用します。

API の使用法:

• リクエストに API キーを含めます。

ヘッダー: X-API-KEY:



• 次の cURL コマンドを使用して API キーをテストします。

```バッシュ
curl -X GET "https://yoursite.com/api/endpoint" \
-H "X-API-KEY: your_api_key_here" \
-H "コンテンツタイプ: application/json"

Postman を使用して認証をテストします。

• Postman を開きます。
• リクエストメソッドとURLを設定します。
• 次に、「ヘッダー」タブに移動します。
• ヘッダーを追加します: キー = "X-API-KEY"、値 = "your_api_key"。

JWT認証:

JWT認証を使用すると、有効なJWTトークン（JSON Web Token）を使用して、カスタムREST APIおよびJoomlaデフォルトAPIエンドポイントへのアクセスを認証できます。このプラグインは、有効なユーザーのJoomlaログイン認証情報を使用してBearer JWTを生成するためのエンドポイントを提供します。生成されたトークンは、カスタムおよびJoomla REST APIエンドポイントの認証に使用できます。

• まず、 認証を有効にする ボタンの APIの詳細を設定する のセクションから無料でダウンロードできます。
• 認証の構成 メニューを選択 JWTベアラー ドロップダウン メニューから選択します。
• 今選択してください APIキーの種類.
• まず 署名アルゴリズム ドロップダウンメニューから選択します。
• HS256、 入力します 秘密鍵.
• RS256、アップロード 公開鍵と秘密鍵.
• 有効期限を入力します (例: 3600 時間の場合は 1)。
• 以下を行うには、 Save

JWT トークンを取得するには、次の手順に従います。

• JWTを取得するには、ユーザーのJoomla認証情報を含むPOSTクエリを送信する必要があります。ユーザー名とパスワードはBase64エンコード形式で送信する必要があります。ご参考までに、以下のリクエスト形式をご参照ください。

リクエスト: POST {joomla_base_url}/api/index.php/v1/mini/id_token
ヘッダ：
認証: 基本 base64 エンコード
受け入れる: application/json
サンプルcurlリクエストフォーマット -
--location --request POST "/api/index.php/v1/mini/id_token' \"
--header '受け入れ: application/json'\
--header 'コンテンツタイプ: application/json' \
--header '認証: 基本 base64 エンコード' \'

ステップ4: REST APIの認証

Joomla のコア API と、Joomla サイトでホストされている API の認証を構成します。これらの API が呼び出されたときに自動的に適用されます。

• に行きます RESTAPI認証 タブには何も表示されないことに注意してください。
• 入力する API名 　 APIエンドポイント 指定されたフィールドで。
• 次に、 HTTPメソッド ドロップダウンメニューから選択します。
• 次に、 認証を有効にする ボタンをクリックして、ご希望の認証方法を選択してください。 ステップ 3 さまざまな認証方法を構成する方法については、ガイドのセクションを参照してください。

ステップ5: 外部APIを構成する

• に行きます 外部API タブには何も表示されないことに注意してください。
• API名を入力します。
• 次に、 APIメソッド をドロップダウンから選択します。
• 入力する 外部 API 与えられたフィールドで。
• この設定されたAPIに必要なクエリパラメータを渡すことができます。データはクエリパラメータの形式で送信されます。
• テキスト フィールドが 2 つあります。XNUMX つ目はキーを入力するためのもので、XNUMX つ目は値を入力するものです。
• たとえば→次のクエリパラメータ「username→testuser」を渡す必要がある場合は、キーに「username」、値フィールドに「testuser」を入力する必要があります。
• + ボタンを使用して複数のパラメータを追加できます。
• ヘッダーには2つのテキストボックスがあります。左側はヘッダー名用、右側は渡す必要があるヘッダー値用です。例えば、渡すヘッダーがAuthorization:Bearerという形式の場合、下図に示すように、最初のテキストボックスに「Authorization」が追加され、「Bearer」は右側のテキストボックスに入力する必要があります。
• APIプロバイダーがAPIエンドポイントリクエストの本文でデータを送信することを要求している場合は、必要な詳細を入力してください。データの送信には、x-www-form-urlencodedとJSONの2つの形式が利用可能です。
• データは x-www-form-urlencoded 形式で本文パラメータに送信されます。
• テキスト フィールドが 2 つあります。XNUMX つ目はキーを入力するためのもので、XNUMX つ目は値を入力するものです。
• たとえば→次の本文パラメータ「username→testuser」を渡す必要がある場合は、キーに「username」、値フィールドに「testuser」を入力する必要があります。
• API エンドポイント リクエストのリクエスト ボディで渡す必要がある複数のキー値のペアの場合は、+ ボタンをクリックできます。
• JSON形式でボディパラメータに送信されるデータについては、リクエストボディに対応するドロップダウンからJSONを選択する必要があります。
• 今すぐ 構成の保存

関連記事

• カスタム API 拡張機能の詳細をご覧ください。
• Joomla とカスタム Web サイト間のリアルタイムのデータ同期。
• Joomla Core API 用の安全な JWT 認証を実装します。