Dotnetnuke (DNN) で外部 REST API エンドポイントを作成する
概要
DNN REST API プラグインを使用すると、外部 API を DNN サイトにスムーズに統合でき、API 呼び出しを通じて外部データの取得および更新操作を実行できます。このプラグインを使用すると、ユーザー ログイン、ユーザー登録などのさまざまな DNN イベントまたは操作中に外部データを取得または更新できます。このガイドでは、DNN サイトの外部 REST API を設定するための手順を段階的に説明します。
前提条件: ダウンロードとインストール
- DNN REST APIの外部APIを設定するには、 miniOrange DNN REST API 認証プラグイン DNNストアより。
- インストールパッケージをアップロードするには、 [設定] > [拡張機能] > [拡張機能のインストール]。
構成手順
DNN 外部 API 認証のステップ バイ ステップ ガイド。
1.DNNページにモジュールを追加します
- DNNサイトの任意のページを開き(編集モード)、 モジュールを追加します。
- 検索する DNN REST API DNN REST API をクリックします。モジュールを目的のページにドラッグ アンド ドロップします。
- DNN サイトへの DNN REST API モジュールのインストールが完了しました。
2. 外部APIを作成する
- に移動します DNN REST API 設定 タブ。ここでは、 DNN REST API プラグイン ダッシュボード。
- ソフトウェアの制限をクリック APIを作成する、 外部 API 生成を開始します。
- 今すぐ選択 外部 API。
- 次の詳細を入力します。
- API名: API に一意の名前を付けます。
- API メソッド: 選択 HTTPリクエストメソッド をドロップダウンから選択します。
- 外部 API エンドポイント: 外部 API エンドポイントを構成します。
- 認証タブから API の認証方法を設定し、必要に応じてヘッダータブからヘッダーを追加できます。
- また、[Body] タブから、JSON、x-www-form-urlencoded、xml などのさまざまな形式で本文のデータを渡すこともできます。
- 詳細設定セクションには、パラメータを渡すオプションがあります。
- 詳細を入力したら、 API を生成します。
- これで、外部 API セクションで、生成された API を見つけることができます。
3. 外部APIをテストする
- APIをテストするには、 ホイール試乗 オプションの下に 行動 ドロップダウン。
- テストポップアップが表示されます。ヘッダーや本文データなどの必要な詳細を入力し、 実行する
- すべてが正しく構成されている場合、外部 API が正しく構成されていることを確認する成功応答が API から返されます。
このガイドでは、外部 API を設定して DNN アプリケーションに統合する方法を説明します。この REST API 統合を DNN と利用することで、DNN アプリケーションからの API 呼び出しを通じて、外部データに対するフェッチ、挿入、更新、削除操作を安全に実行できます。
