の検索結果 :

×

Joomla のカスタム API 拡張機能をセットアップする

Joomla のカスタム API 拡張機能をセットアップする


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

前提条件: ダウンロードとインストール

インストール

  • zip ファイルをダウンロードします。 miniOrange カスタム API プラグイン Joomlaの場合はリンクから こちら.
  • Joomla サイトにログインします。 管理者 コンソール。
  • 左側のトグルメニューから、 をクリックします エントルピー、次に インストールを開始する セクションをクリック 拡張機能.
  • カスタム API プラグインのダウンロードとインストール
  • ここをクリックしてください ファイルを参照 ボタンをクリックして、前にダウンロードしたプラグイン ファイルを見つけてインストールします。
  • コンピュータからカスタム API プラグインをインストールする
  • プラグインのインストールが成功したら。 今すぐクリックしてください miniOrange カスタム API プラグインの使用を開始する.
  • miniOrange カスタム API プラグインの使用を開始する

カスタム API プラグインの構成

1. カスタム API を作成します。

ミニオレンジ画像 API を取得する理由:

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

ミニオレンジ画像 カスタム GET API を作成するための構成:

  • Joomlaの「カスタムAPIの作成」タブに移動し、「ここをクリック」ボタンをクリックします。
  • Joomla カスタム API を作成する
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に、 GETメソッド をドロップダウンから選択します。
  • 次に、データ取得アクションを実行するテーブル名を選択します。
  • Joomla カスタム GET メソッド
  • この API の列とフィルターを選択するための複数のオプションが表示されます。 Joomla サイトからデータを取得するテーブルの列を指定してください。 ここで複数の列を選択できます。
  • 要件に応じて適切な条件を選択することも、条件を選択しないこともできます。 クリック + 複数の WHERE 条件を追加してデータをフィルタリングする場合は、 ボタンをクリックします。 をクリックして条件を削除することもできます。 -
  • 最後に、データを並べ替える場合は、ORDERBY フィルターを選択します。
  • API を設定した後、 をクリックします。 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。
  • Joomla カスタム API エンドポイント - REST API

ミニオレンジ画像   作成したGET APIの使い方:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • Joomla用カスタムAPI - get APIの作成方法
  • に存在するパラメータを渡す必要があります。 リクエストフォーマット リクエストのクエリパラメータの形式のテーブル。
  • 上記の例のユーザーのデータを取得するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/custom_get」.
    • 2) 次に、 GET HTTPメソッド。
    • 3) IDをとして渡します クエリパラメータ.
  • 以下に示すように、JSON 形式で API 応答を受け取ります。
  • Joomla のカスタム エンドポイント - JSON 形式のカスタム API 応答

ミニオレンジ画像 POST API を使用する理由:

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

ミニオレンジ画像 カスタム POST API を作成するための構成:

  • Joomlaの「カスタムAPIの作成」タブに移動し、「ここをクリック」ボタンをクリックします。
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に、ドロップダウンから POST メソッドを選択します。
  • 次に、新しいデータを入力するテーブル名を選択します。 次に、をクリックします Save
  • Joomla のカスタム Rest API - カスタム API POST メソッド
  • 次に、テーブルにエントリを追加するデータを提供する列を選択します。
  • ここで、ヘッダーにデータを送信するデータ形式を選択できます。
  • Joomla 用のカスタム API
  • API を設定した後、 をクリックします。 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

ミニオレンジ画像 作成したPOST APIの使い方

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • Joomla のカスタム API - Joomla のカスタム エンドポイント
  • 「リクエスト形式」の表に記載されている列にデータを提供するには、リクエストの本文に必要な値を含める必要があります。
  • 本文データ形式が「本文データ形式」セクションで指定された形式と一致していることを確認してください。
  • 上記の例の usergroup テーブルにエントリを追加するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/custom_post」.
    • 2) 次に、 POST HTTPメソッド。
    • 3) データを渡す id、parent_id、lft、rgt、タイトル リクエストの本文に記載されています。
  • データがテーブルに正常に入力された場合、応答で 1 を受け取ります。
  • Joomla 用のカスタム REST API

ミニオレンジ画像 API を配置する理由:

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

ミニオレンジ画像 カスタムPUT APIを作成するための設定

  • Joomlaの「カスタムAPIの作成」タブに移動し、「ここをクリック」ボタンをクリックします。
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に、ドロップダウンからメソッド PUT を選択します。
  • 次に、新しいデータを入力するテーブル名を選択します。
  • Joomla のカスタム Rest API - カスタム API メソッド PUT
  • 次に、API 呼び出しを使用して更新する列を選択します。
  • 要件に応じて適切な条件を選択することも、条件を選択しないこともできます。 複数の WHERE 条件を追加してデータをフィルタリングする場合は、+ ボタンをクリックします。 - ボタンをクリックすると、条件を削除することもできます。
  • Joomla のカスタム エンドポイント - カスタム PUT API
  • API を設定した後、 をクリックします。 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

ミニオレンジ画像 PUT APIの使用方法:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • Joomla のカスタム REST API -カスタム PUT API
  • データをクエリ パラメーターとして渡すことも、リクエストの本文内で渡すこともできる柔軟性があります。
  • 特定の要件に従って、key=パラメータ名(適用されるリクエストの形式と条件の表に記載)およびvalue=の形式を使用してデータを渡すようにしてください。
  • 上記の例のユーザー エントリを更新するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/custom_put」.
    • 2) 次に、 PUT HTTPメソッド。
    • 3) データを渡す 名前、ユーザー名、param_1、param_2 リクエストの本文に含めます(クエリ形式で渡すこともできます)。
  • テーブル内のデータが正常に更新された場合、応答で 1 を受け取ります。
  • Joomla のカスタム API - カスタム API が成功しました 更新されました

ミニオレンジ画像 API を削除する理由:

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

ミニオレンジ画像 カスタム DELETE API を作成するための構成:

  • Joomlaの「カスタムAPIの作成」タブに移動し、「ここをクリック」ボタンをクリックします。
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に方法を選択します DELETE をドロップダウンから選択します。
  • 次に、データを削除するテーブル名を選択します。
  • Joomla カスタム削除メソッド
  • 要件に応じて適切な条件を選択することも、条件を選択しないこともできます。 クリック + 複数の WHERE 条件を追加してデータをフィルタリングする場合は、 ボタンをクリックします。 をクリックして条件を削除することもできます。 -
  • Joomla のカスタム削除メソッド
  • API を設定した後、 をクリックします。 Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

ミニオレンジ画像 DELETE APIの使用方法:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • Joomla カスタム削除 API - カスタム API エンドポイント
  • データをクエリ パラメーターとして渡すことも、リクエストの本文内で渡すこともできる柔軟性があります。
  • 特定の要件に従って、key=パラメータ名(適用されるリクエストの形式と条件の表に記載)およびvalue=の形式を使用してデータを渡すようにしてください。
  • 上記の例のユーザー エントリを削除するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/custom_delete」。
    • 2) 次に、 DELETE HTTPメソッド。
    • 3) データを渡す param_1 リクエストの本文に含めます(クエリ形式で渡すこともできます)。
  • 次の場合、応答で 1 を受け取ります。 データは正常に削除されました テーブルに。
  • Joomla カスタム削除 API

2. カスタム SQL API を作成します。

ミニオレンジ画像 カスタム SQL GET API を作成するための構成:

  • 1. Joomla Create SQL API タブに移動し、「ここをクリック」ボタンをクリックします。
  • Joomla SQL API 作成
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に、ドロップダウンから GET メソッドを選択します。
  • 注: API リクエストでカスタム パラメータを送信する場合は、カスタム クエリ パラメータを有効にすることもできます。
  • API 呼び出しが成功したときに実行するカスタム SQL クエリを作成します。
  • Joomla Create SQL API 名
  • 注: カスタム パラメーターを送信するには、次のようなクエリを作成します。 SELECT * FROM #__users WHERE id='{{id_param}}' AND email='{{email_param}}'; パラメータ名に _ を含めるのは必須です.
  • ソフトウェアの制限をクリック Save 最後にボタンをクリックして、カスタム エンドポイント/REST API を作成します。

ミニオレンジ画像 作成されたSQL GET APIの使用方法:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • Joomla SQL API - カスタム API エンドポイント
  • 上記の例のユーザーのデータを取得するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/sql_get」。
    • 2) 次に、 GET HTTPメソッド。
    • 3) 合格 ID、メールアドレス クエリパラメータとして。
  • 以下に示すように、JSON 形式で API 応答を受け取ります。
  • Joomla SQL API - JSON 形式

ミニオレンジ画像 カスタム SQL POST API を作成するための構成:

  • Joomla Create SQL APIs タブに移動し、「ここをクリック」ボタンをクリックします。
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に、ドロップダウンからメソッド POST を選択します。
  • 注: API リクエストでカスタム パラメータを送信する場合は、カスタム クエリ パラメータを有効にすることもできます。
  • API 呼び出しが成功したときに実行するカスタム SQL クエリを作成します。
  • Joomla カスタム SQL ポスト SQL クエリを作成する
  • 注: カスタム パラメーターを送信するには、次のようなクエリを作成します。 INSERT INTO #__users (id, name, username, email, registerDate, params) VALUES '{{id}}','{{name}}','{{username}}','{{email}}', '{{登録日}}'、'{{params}}';
  • 最後に「保存」ボタンをクリックしてカスタムエンドポイント/REST APIを作成します。

ミニオレンジ画像 作成した SQL POST API の使用方法:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • カスタム SQL ポストのセットアップ
  • 上記の例のユーザーのデータを取得するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/sql_post」。
    • 2) 次に、 POST HTTPメソッド。
    • 3) 合格 ID、名前、ユーザー名、メールアドレス、登録日、 リクエスト本文のparams。
  • データがテーブルに正常に入力された場合、応答で 1 を受け取ります。
  • カスタム SQL POST API の作成 - 正常に入力されました

ミニオレンジ画像 カスタム SQL PUT API を作成するための構成:

  • Joomla Create SQL APIs タブに移動し、「ここをクリック」ボタンをクリックします。
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に、ドロップダウンからメソッド PUT を選択します。
  • 注: API リクエストでカスタム パラメータを送信する場合は、カスタム クエリ パラメータを有効にすることもできます。
  • API 呼び出しが成功したときに実行するカスタム SQL クエリを作成します。
  • JoomlaカスタムSQL putメソッド
  • 注: カスタム パラメーターを送信するには、次のようなクエリを作成します。 UPDATE #__users set username='{{username}}' where id='{{id}}';
  • 最後に [保存] ボタンをクリックして、カスタム エンドポイント / REST API を作成します。

ミニオレンジ画像 作成した SQL PUT API の使用方法:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • 作成された SQL PUT API の使用方法 - エンドポイント
  • 上記の例のユーザーのデータを更新するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/sql_put」.
    • 2) 次に、 PUT HTTPメソッド。
    • 3) 合格 ユーザー名、ID リクエストの本文またはクエリパラメータ内で。
  • データがテーブルに正常に入力された場合、応答で 1 を受け取ります。
  • Joomla CustomAPI - PUT HTTP メソッド

ミニオレンジ画像 カスタム SQL DELETE API を作成するための構成:

  • Joomla Create SQL APIs タブに移動し、「ここをクリック」ボタンをクリックします。
  • 次に、API に提供する API 名を入力します。 API の名前にスペースが追加されていないことを確認してください。
  • 次に方法を選択します DELETE をドロップダウンから選択します。
  • 注: API リクエストでカスタム パラメータを送信する場合は、カスタム クエリ パラメータを有効にすることもできます。
  • API 呼び出しが成功したときに実行するカスタム SQL クエリを作成します。
  • カスタム SQL DELETE API を作成する
  • 注: カスタム パラメーターを送信するには、次のようなクエリを作成します。 #__users WHERE id='{{id}}'; から削除します。
  • 最後に「保存」ボタンをクリックしてカスタムエンドポイント/REST APIを作成します。

ミニオレンジ画像 作成された SQL DELETE API の使用方法:

  • [保存] ボタンをクリックすると、カスタム API/エンドポイントを受け取ります。 この API は、特定の要件に基づいて任意のプラットフォームで利用できます。
  • 作成したSQL DELETE APIの使用方法
  • 上記の例のユーザーのデータを削除するには、次の手順に従う必要があります。
    • 1) URLを入力してください 「http://localhost/joomla_4.3.1/api/index.php/v1/mini/sql_delete」。
    • 2) 次に、 DELETE HTTPメソッド。
    • 3) 本文にIDを渡します リクエストまたはクエリパラメータ内.
  • データがテーブルに正常に入力された場合、応答で 1 を受け取ります。
  • Joomla のカスタム API のセットアップ -DELETE HTTP メソッド

3. 既存の API を編集します。

  • 編集するカスタム API の前にある編集ボタンをクリックします。
  • Joomla のカスタム API のセットアップ - 既存の API の編集
  • 要件に従って API を更新し、「保存」をクリックします。 その後、要件に応じて更新された API を使用します。

4. カスタム API へのパブリック アクセスの制限:

  • ソフトウェアの制限をクリック 「認証の追加」タブ プラグインのナビゲーションバーにあります。
  • 有効にします 必要に応じてボタンを押してください トークンベースの認証を追加 カスタム API に。
  • あなたは選ぶことができます HTTP 認証方法を追加するメソッド。
  • 次にをクリックしてください Save
  • 今、あなたはをクリックすることができます "見せる" アイコンを確認してください ベアラートークン あなたはまた、 新しいキーを生成する をクリックして 「新しいキーを生成」.
  • Joomla カスタム API - 新しいキーを生成する
  • 制限された API にアクセスするには、Bearer Token of Authorization の Bearer Token 値を渡す必要があります。
  • Joomla カスタム API - ベアラー トークン

5. 外部 API 構成:

ミニオレンジ画像 さまざまなメソッドを使用して外部 API を構成します。

  • 「外部 API」タブに移動し、「外部 API の構成」ボタンをクリックします。
  • API 接続に付与する API 名を入力します。 この API 名は Joomla に接続するために使用されるため、一意である必要があります。
  • Joomla サイトに接続するメソッドを選択ドロップダウンから外部 API に応じて選択します。
  • さまざまなメソッドを備えた Joomla 外部 API
  • この設定された API に必要なクエリ パラメータを渡すことができます。 クエリパラメータ形式で送信されるデータの場合:
    • 1) 2 つのテキスト フィールドがあります。XNUMX つ目はキーを入力し、XNUMX つ目は値を入力します。
    • 2) 例→ 次のクエリパラメータを渡す必要がある場合 'ユーザー名→テストユーザー' 次に、を置く必要があります 「ユーザー名」 鍵の中と 'テストユーザー' 値フィールドに。
    • 3) 次を使用して複数のパラメータを追加できます +
  • ヘッダーには 2 つのテキスト ボックスがあります。左側はヘッダー名用で、右側は渡す必要があるヘッダー値用です。 例: ヘッダーが Authorization:Bearer の形式で渡された場合 そうして 「認可」 最初のテキストボックスと「Bearer」に追加されます 以下の図に示すように、右のテキストボックスに入力する必要があります。
  • さまざまなメソッドを備えた Joomla 外部 API
  • API プロバイダーが API エンドポイント リクエストの本文でデータを送信する必要があると想定している場合は、必要な詳細を入力できます。 データの送信には、x-www-form-urlencoded と JSON の 2 つの形式を使用できます。
  • x-www-form-urlencoded 形式の本文パラメータでデータを送信するには:
    • 1) 2 つのテキスト フィールドがあります。XNUMX つ目はキーを入力し、XNUMX つ目は値を入力します。
    • 2) 例→ 次の本体パラメータ「username→testuser」を渡す必要がある場合、キーに「username」を入力し、値フィールドに「testuser」を入力する必要があります。
    • 3) API エンドポイント リクエストのリクエスト本文で渡す必要がある複数のキーと値のペアについては、[+] ボタンをクリックできます。
  • JSON 形式の本文パラメーターでデータを送信するには: リクエスト本文に対応するドロップダウンから JSON を選択する必要があります。
  • JSON形式のJoomlaパラメータ
  • 今すぐ Save
  • 次に、「構成のテスト」をクリックして API 接続をテストし、応答を取得します。 以下に示すような属性テーブルを受け取ります。
  • Joomla のカスタム API のセットアップ

ミニオレンジ画像 外部 API のショートコード:

  • 外部 API を構成すると、特定の API のショート コードを受け取ります。
  • Joomla のカスタム API のセットアップ - 外部 API のショート コード
  • Joomla 記事でこのショートコードを使用して、記事にデータを表示できます。

ビジネストライアル

ビジネストライアルを無料でご希望の場合 ここをクリック

探しているものが見つからない場合は、下記までお問い合わせください。 joomlasupport@xecurify.com または下記までお電話ください +1 978 658 9387.

こんにちは!

助けが必要? 私たちはここにいます!

サポート
miniOrange サポートにお問い合わせください
成功

お問い合わせありがとうございます。

24 時間以内に当社からのご連絡がない場合は、お気軽にフォローアップ メールを送信してください。 info@xecurify.com