Joomla カスタム API 拡張機能設定ガイド
概要
その JoomlaカスタムAPI拡張機能 Joomla CMS（コンテンツ管理システム）の機能を拡張するためのカスタムAPIを作成できます。これらのAPIを使用することで、 Joomlaウェブサイトから特定の機能やデータを公開する外部プログラムやサービスがJoomlaウェブサイトと通信できるようにします。このプラグインは、独自に開発したカスタムエンドポイントを利用してJoomlaデータベースをスムーズに操作する方法を提供し、簡単に実行できます。 CRUD（作成、読み取り、更新、削除） 操作。
ステップ1: カスタムAPI拡張機能のインストール
- zip ファイルをダウンロードします。 miniOrangeカスタムAPI拡張 Joomla については上記のリンクから。
- Joomla サイトにログインします。 管理者 コンソール。
- 左側のトグルメニューから、 をクリックします システム、次に インストールを開始する セクションをクリック 拡張機能.
- ここをクリックしてください ファイルを参照 ボタンをクリックして、先ほどダウンロードした拡張機能ファイルを見つけてインストールします。
- プラグインのインストールが成功したら。 今すぐクリックしてください JoomlaカスタムAPIプラグインの使用を開始する.
注意： このガイドでは、Joomla Custom API拡張機能の無料版とプレミアム版の両方の設定手順を説明します。無料版で利用可能な機能については、無料版のインターフェースを使用して手順を説明します。プレミアム版専用の機能については、対応する手順をそれぞれ示します。無料版とプレミアム版ではユーザーインターフェースに若干の違いが見られる場合がありますが、全体的な設定プロセスは変わりません。
ステップ2: カスタムAPIを作成する
- GET
- POST 【プレミアム】
- PUT 【プレミアム】
- DELETE 【プレミアム】
ステップ3: API認証を構成する 【プレミアム】
- ベアラートークン
- JWT認証
- 基本認証
- ＡＰＩキー
ステップ4: REST APIの認証 【プレミアム】
Joomla のコア API と、Joomla サイトでホストされている API の認証を構成します。これらの API が呼び出されたときに自動的に適用されます。
- に行きます RESTAPI認証 タブには何も表示されないことに注意してください。
- 入力する API名 (NAIST) と 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を選択する必要があります。
- 今すぐ 構成の保存
ステップ6：JoomlaコアREST APIの設定 【プレミアム】
- に移動します JoomlaコアREST API タブをクリックして 新しいAPIを設定する
- Joomla Core REST API を設定するには、API 認証トークンが必要です。 ユーザー -> 管理 -> ユーザーをクリック.
- ここから Joomla APIトークン タブをクリックしてコピーします トークン.
- に戻る Joomla Core REST API タブを押して、生成されたトークンを指定されたフィールドに貼り付けます。この構成の名前を入力し、次に必要な項目を選択します。 エンドポイント ドロップダウンメニューから選択してください。必要に応じて適用することもできます。 クエリフィルター を構成します エンドポイントフィールド 好ましいものと共に 出力フォーマットすべて設定が完了したら、 テストAPI 設定を確認するためのボタン。
- あなたが表示されます API応答 設定が成功した場合、次にクリックします。 設定を保存
- あなたの Joomla Core REST API 設定が正常に完了しました。生成されたファイルをコピーできます。 ショート このセクションからコードを取得し、サイト上の任意の場所に配置すると、APIレスポンスをフロントエンドに直接表示できます。
