3.2.1.5. 「API」タブ

アプリで利用するネクストエンジンAPIに関する情報を設定できます。

以下の場合のみ設定ができます。

・アプリの種類が「メイン機能と連携するアプリ」、「ネクストエンジンログインのみのアプリ」の場合

概要

  • ネクストエンジンでAPIを利用できるアプリは原則Webアプリケーションを想定しています
  • アプリの稼働するサーバーはアプリ開発をされる企業様でご用意いただく必要がございます
  • 詳しくは「ネクストエンジンAPIマニュアル」をご参照ください
  • アプリ開発で必要なAPIのご利用には「API」の設定が必須です
  • 審査が完了するまでは「テスト環境設定」で設定したクライアントID、クライアントシークレットのみ利用可能です
  • アプリ販売後の利用開始までは本番環境設定(通常利用しているメイン機能)でのテストはできませんのでご注意ください

本番環境設定(審査時必須)

販売が開始されてから使用される環境を設定します。

RedirectURI

リダイレクトURIを設定します。https必須、最大200文字(半角英数字)まで入力が可能です。

リダイレクトURIとは
ネクストエンジンAPIでは、(1)API(弊社)と(2)アプリ(アプリ開発企業様)のサーバーとでHTTP通信を行い必要な情報をやりとりします。その際に(1)から(2)へリダイレクトするURLをリダイレクトURIとしています。
クライアントID

RedirectURIを入力後、「更新」ボタンを押すと設定されます。

クライアントシークレット

RedirectURIを入力後、「更新」ボタンを押すと設定されます。 新しい値を設定したい場合は、クライアントシークレット文字の横にある(更新)をクリックします。 更新すると、稼働中のAPIアクセスは無効になります。

クライアントID、クライアントシークレットとは
ネクストエンジンAPIがアプリを識別するために必要なIDとパスワードのようなものです。1つのアプリに本番とテスト用の値が存在します。非常に重要な情報ですので、絶対に第三者には公開せず厳重に扱ってください。

テスト環境設定(審査時必須)

テストで使用される環境を設定します。開発中はこちらの値をご利用いただくことになります。アプリの審査承認にはテスト環境でテストをできることが必要です。

実行設定

実行方法

アプリを実行する(起動する)方法を指定できます。

単独機能として実行:
ネクストエンジンの下部アプリランチャーや、ヘッダーメニューのアプリ一覧に表示され、クリックすることでアプリを起動します。
弊社アプリ「カスタムデータ作成」などがこれにあたります。

ネクストエンジンの拡張機能として実行:
メイン機能の検索結果画面にて選択したデータに対する実行が行えます。
メイン機能からシームレスにアプリのアクションに繋がるのが特徴です。
弊社アプリ「受注伝票一括更新アプリ」などがこれにあたります。

これらは複数選択が可能となります。アプリの性質によりお選びください。
「単独機能として実行」にチェックをつけず「ネクストエンジンの拡張機能として実行」のみにチェックをつけているとネクストエンジンの下部アプリランチャーには表示されません。
その他詳しい説明はDeveloper Networkをご確認ください。

拡張機能の概要

「実行方法」にて「ネクストエンジンの拡張機能として実行」を選んでいる場合に必須の項目です。
アプリ選択時(メイン機能の検索結果画面にてアプリアイコンにマウスカーソルを当てた時)に表示される説明文となります。
下部画像の赤枠の部分

拡張機能の説明画像

アプリ選択時(メイン機能の検索結果画面にてアプリアイコンにマウスカーソルを当てた時)に表示される説明画像となります。
下部画像の赤枠の部分

PFマニュアル用

拡張機能の実行対象

どのデータに対して機能を実行できるようにするかを選択できます。
例えば受注伝票の場合は受注ステータスに対して選択することが可能です。
「印刷待ち」の伝票のみを実行対象としたい場合は「受注伝票」の「印刷待ち」のみにチェックを入れればOKです。

拡張機能の実行画面有無

「実行画面有り」にチェックがない場合、アプリ画面にリダイレクトはせず実行レスポンスを待ちます。(その場で処理が終わるまで待機)
「実行画面有り」にチェックがある場合、アプリ画面にリダイレクトします。
詳しくはこちら
Developer Network

拡張機能の設定画面有無

「設定画面有り」にチェックがある場合、メイン機能>設定>アプリに表示され、クリックするとアプリの設定画面を開きます。
設定画面有り

拡張機能の開き方

アプリをクリックした際に「新しいウィンドウで開く」か「起動した画面で開く」か「新しいタブで開く」が選択できます。
これらはアプリ購入時の初期値としての設定となり、購入後ユーザーがユーザー毎に任意の開き方に変更できます。
詳しくはこちら
Developer Network

拡張機能のマニュアルURL

アプリのマニュアルのURLを記載してください。
アプリをメイン機能と同一の画面(起動した画面)で開いた場合に、メイン機能のメニュー(マニュアル→この画面のマニュアル)にアプリのマニュアルURLを指定することができます。
この画面のマニュアル

アクセス情報

メイン機能のAPI一覧です。アプリで使用するAPIの利用許可、不許可を選択します。 アクセス情報が適切に設定されていないとAPIがご利用できませんのでご注意ください。アプリの種類が「メイン機能と連携するアプリ」の場合のみ設定できます。

アクセス情報とAPIの対応は「ネクストエンジンAPIマニュアル – リクエストURL一覧」をご参照ください。