API エクスプローラについて

API エクスプローラについて

API エクスプローラには、REST API 用の制限付きインターフェイスが用意されており、REST API の機能が表示されます。

API エクスプローラは Management Center にあり、次の URL の Management Center からアクセスできます。

https://<management_center_IP_or_name>:<https_port>/api/api-explorer

バージョン 6.4 は OpenAPI 仕様（OAS）に基づいて、新しい API エクスプローラを使用します。必要に応じて、レガシー API エクスプローラにもアクセスできます。

オープン API 仕様の一部として、CodeGen を使用してサンプルコードを生成できます。CodeGen は、Swagger で提供されるユーティリティであり、オープン API 仕様から API クライアントライブラリとコードを生成します。詳細については、「CodeGen を使用したサンプルコードの取得」を参照してください。

このエクスプローラには、Management Center で使用できる API の一覧とその詳細が表示されます。

CDO では、API エクスプローラは CDO プラットフォームで実行され、API エクスプローラの呼び出しはすべてクラウド提供型 Management Center に影響することに注意してください。

API エクスプローラへの認証

REST API は Management Center と同じ認証を使用します。REST API の各関数は、Management Center 内の権限に対応します。

Management Center のアカウントを使用して API エクスプローラにログインすることができますが、そのアカウントが権限を持っている機能のみ実行することができます。ユーザ役割の権限の設定については、『Firepower Management Center Configuration Guide』を参照してください。1 つのアカウントで、API エクスプローラを含む REST API インターフェイスとユーザーインターフェイスの両方を同時に使用することはできません。一方にログインすると、もう一方は警告なしでログアウトされます。このため、ユーザーインターフェイスと REST API に個別のアカウントを使用することを推奨します。

API エクスプローラに初めて接続する際は、無効な証明書により接続が安全ではないというエラーが表示される場合があります。証明書を使用して接続を許可するように、ブラウザに例外を追加する必要があります。

API エクスプローラへのログイン

REST API は、Management Center と同じ認証および権限モデルを使用します。詳細については、『Firepower Management Center Configuration Guide』（英語）を参照してください。

始める前に

Management Center に、REST API を使用してタスクを実行するのに必要な権限を持っているアカウントがあることを確認します。

手順

ステップ 1

次の URL に移動します：https://<management_center_IP_or_name>:<https_port>/api/api-explorer

Firefox ブラウザを使用しているときに、ログオン画面のロードに時間がかかる場合、about:support と検索バーに入力して [Firefoxをリフレッシュ（Refresh Firefox）] オプションをクリックすると、同じ Firefox ブラウザに自己署名証明書と、Management Center インターフェイスが表示されます。詳細については、https://support.mozilla.org/en-US/kb/refresh-firefox-reset-add-ons-and-settings を参照してください。

ステップ 2

ユーザー名とパスワードでログインし、[サインイン（Sign In）] をクリックします

次のタスク

必要なリソースと要求を探します。

ドメインの設定

デフォルトのドメインまたは特定のドメインで、REST API はグローバルに関数を実行できます。

始める前に

設定済みの Management Center と、Management Center で構成されている 1 つまたは複数のドメインで REST API にアクセスする権限を持つアカウントが必要です。

手順

右上の [ドメイン（Domains）] メニューをドロップ ダウンして、目的のドメインを選択します。

次のタスク

目的のリソースと要求タイプを探します。

レガシー API エクスプローラへのアクセス

6.4.0 に対応するように API エクスプローラが変更されました。新しい API エクスプローラでは以前の機能のほとんどが保持されていますが、一部のユーザーは古いインターフェイスを好むことがあります。

始める前に


（注）  

レガシーエクスプローラは、Management Center の今後のリリースで削除されます。将来、現在の REST API 機能にアクセスするには、オープン API 仕様を使用してください。

Management Center に、REST API を使用してタスクを実行するのに必要な権限を持っているアカウントがあることを確認します。

https://<management_center_IP_or_name>:<https_port>/api/api-explorer で API エクスプローラにログインします。

手順

右上隅の [レガシー エクスプローラ（Legacy Explorer）] をクリックします。

次のタスク

通常どおり、レガシー API エクスプローラを使用します。

CodeGen を使用したサンプル コードの取得

オープン API 仕様に基づいて CodeGen ユーティリティを使用し、さまざまな言語でサンプル コードを生成できます。このユーティリティは、オンラインでダウンロードできるオープンソース ツールです。結果コードは、主に学習用ブートストラップ ツールとして使用するためのものです。

CodeGen ユーティリティは、オープン API 仕様全体用のサンプル コードを作成します。そのため、REST API では許可されたすべてのメソッドとエンドポイントのサンプル コードが生成されます。サンプル コードは、HTML、Perl、Python、Java などのさまざまな言語で使用できます。

CodeGen ユーティリティの完全なドキュメントについては、次の URL を参照してください。 https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/

オープン API 仕様のダウンロード

オープン API 仕様は、REST API の標準化された仕様です。Management Center REST API のオープン API 仕様には、API のエンドポイント、フィールド、パラメータ、および要件に関する詳細が含まれています。API 仕様を使用してサンプル コードを生成したり、API 機能に関する特定の情報を検索できます。

オープン API 仕様は JSON ファイルです。ほとんどのテキスト エディタで読み取ることができます。

始める前に

API エクスプローラにアクセスできるアカウントが Management Center があります。

ブラウザが自己署名証明書を使用してサイトからダウンロードできること。

手順

ステップ 1

API エクスプローラへのログインに記載されている手順を使用して API エクスプローラを開きます。

ステップ 2

右上隅の [仕様のダウンロード（Download Spec）] をクリックします。ブラウザの設定に応じて、ファイルを保存するように促されるか、またはファイルが直接表示されます。

ステップ 3

ファイルを保存します。宛先とファイル名に注意してください。

次のタスク

ダウンロードしたファイルで CodeGen ユーティリティを実行します。

CodeGen ユーティリティを使用したサンプル コードの生成

Swagger CodeGen ユーティリティを使用すると、オープン API 仕様からサンプル コードを生成できます。このサンプル コードは、Java、HTML、Python、Perl などのさまざまな言語で使用できます。

始める前に

Swagger CodeGen ユーティリティをダウンロードします。CodeGen を使用したサンプル コードの取得を参照してください。

Jave ランタイム環境がコンピュータにインストールされていること

Management Center REST API オープン API 仕様をダウンロードします。オープン API 仕様のダウンロードを参照してください。

CodeGen ユーティリティを実行できるように環境変数を設定すること

手順

コマンド ラインから java -jar ./swagger-codegen-cli-<VERSION>.jar generate -o <OUTPUT_PATH> -l <LANGUAGE> -i <OPEN_API_SPEC_FILE> コマンドを実行します。

例:

java -jar ./swagger-codegen-cli-2.3.1.jar generate -o C:\work\code\api_schema\html -l html -i fmc_swagger.json

<VERSION> は、使用している CodeGen ユーティリティの特定のバージョンです。これは CodeGen .jar ファイルのファイル名と一致している必要があります。

<OUTPUT_PATH> は生成されたコードを出力するパスです。

<LANGUAGE> は CodeGen で生成する言語です。推奨されるオプションには、 html、 java、 perl、python などがあります。その他のオプションを使用することもできます。選択肢の詳細なリストについては CodeGen のドキュメントを確認してください。

<OPEN_API_SPEC_FILE> はダウンロードしたオープン API 仕様のファイルです。これは CodeGen がサンプル コードを生成するためのソースです。このコマンドを使用しないと、CodeGen は出力を提供できません。

次のタスク

生成されたコードを出力パスで検索し、必要に応じて使用します。生成されたコードは一例として考える必要があります。また、必要に応じて変更しない限り、希望どおりに実行されないことがあります。

API パラメータの表示

各リソースには、パラメータとそれに関連付けられたフィールドのセットがあります。API エクスプローラ内でそのリソースに対しサポートされている操作のいずれかを実行することによって、パラメータやフィールドを表示できます。

始める前に

設定済みの Management Center と、目的の REST API 関数を使用するために必要な権限を持つアカウントが必要です。

手順

ステップ 1

API エクスプローラを開きます。を参照してくださいAPI エクスプローラへのログイン。

ステップ 2

目的のリソースを選択します。

ステップ 3

そのリソースに対しサポートされている操作のいずれかを選択します。