API Connect ツールキットのセットアップ

ファイルの内容は、選択したツールキットオプションとプラットフォームによって以下のように異なります：

• apic-slim ファイルまたは apic-slim.exe ファイルは、 IBM API Connectの CLI です。
• apic ファイルまたは apic.exe ファイルは、 IBM API Connectの CLI です。
  ヒント: CLI オプションを使用している場合、 apic-slim ファイルの名前を apicに変更するか、 apic-slim.exe ファイルの名前を apic.exeに変更すると、資料に記載されているとおりに CLI コマンドを実行したり、資料からサンプル・コマンドをコピー・アンド・ペーストしたり、任意のコマンド・スクリプトをそのまま使用したりできます (後で CLI + Designer オプションに移動する場合)。
• api_designer-platform ファイルは、指定されたプラットフォーム用の API Designer ユーザー・インターフェース・アプリケーションです。

• Mac OSX または Linux® プラットフォームの場合は、以下の手順を実行します。
  1. ターミナル・インスタンスを開き、ツールキット圧縮ファイルの内容を解凍したフォルダに移動する。
  2. 以下のコマンドを入力して、CLI ファイルを実行可能ファイルに変換します。

     chmod +x download_name

     ここで download_name は、ダウンロードしたツールキット・ファイルの名前 (apic または apic-slim) です。
  3. 以下のように入力して CLI コマンドを実行します。

     ./apic command_name_and_parameters

     または

     ./apic-slim command_name_and_parameters

     CLI コマンドについて詳しくは、 ツールキット CLI リファレンス資料を参照してください。
• Windows プラットフォームの場合は、以下のステップを実行します。
  1. コマンドプロンプトを開き、ツールキット圧縮ファイルの内容を解凍したフォルダに移動します。
  2. 以下のように入力して CLI コマンドを実行します。

     apic command_name_and_parameters

     または

     apic-slim command_name_and_parameters

     CLI コマンドについて詳しくは、 ツールキット CLI リファレンス資料を参照してください。

端末ウィンドウ (または Windows コマンド・プロンプト) を開き、以下のコマンドを実行して、ツールキットの資格情報をインストールします。

apic client-creds:set <toolkit_credentials_file_path>/credentials.json

ここで、 < credentials_file_path> は、ツールキット資格情報 JSON ファイルをダウンロードした場所です。 ツールキットは、これらの新しい資格情報を使用して、API Manager をホストしているサーバーで認証を行います。

ご使用のオペレーティング・システムに適したメカニズムを使用して、 APIC_DESIGNER_CREDENTIALS 環境変数を資格情報のダウンロード・ロケーションに設定することで、 API Designer 資格情報をインストールします。

Windows: 以下のいずれかの方法で環境変数を作成します。

• コンピューター上の任意の場所から API Designer を開始できるように、永続的な環境変数を作成します。
  1. 「環境変数」ページを開きます。 「開始」 > 「設定」 > 「システム」 をクリックし、ページの「関連設定」セクションで 「拡張システム設定」をクリックします。
  2. 「システム・プロパティー」ダイアログ・ボックスの「拡張」タブで、 「環境変数」をクリックします。
  3. 「ユーザー変数」セクションで、 「新規」 をクリックし、以下の設定を使用して環境変数を作成します。
     • 変数: APIC_DESIGNER_CREDENTIALS
     • 値: <designer_credentials_file_path>\designer_credentials.json 。ここで、 <designer_credentials_file_path> は、 designer_credentials.json ファイルを保管した場所です。
  4. 「OK」 をクリックして新しい環境変数を保存し、ダイアログ・ボックスを終了します。
• API Designer アプリケーションの実行中にのみ使用される一時環境変数を作成します。

  API Designer を開始するたびに、以下のステップを実行する必要があります。

  1. Windows コマンド・プロンプトを開きます。
  2. 以下のコマンドを実行して、一時環境変数を設定します。

     set APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>\designer_credentials.json

     ここで、 <designer_credentials_file_path> は、 designer_credentials.json ファイルを保管した場所です。

     注: 次のステップのために、コマンド・プロンプトを開いたままにしておきます。 一時変数を設定し、同じ Windows コマンド・セッション内で API Designer を開始する必要があります。
  3. 次に、以下のコマンドを実行して API Designer を開始します。

     C:\"Program Files\API Designer\API Designer.exe"

     デフォルトでは、例に示すように、API Designer は C:\"Program Files\API Designer フォルダーにインストールされます。 別の場所にインストールした場合は、コマンドで独自の場所を使用してください。 パスとファイル名にはスペースが含まれているため、引用符で囲まれていることに注意してください。

Mac OS X : 以下のいずれかの方法で環境変数を作成します

• 以下のコマンドを実行して、永続グローバル環境変数を設定します。

  launchctl setenv APIC_DESIGNER_CREDENTIALS <designer_credentials_file_path>/designer_credentials.json

  ここで、 <designer_credentials_file_path> は、 API Designer 資格情報 JSON ファイルを保管した場所です。
• コマンド・ラインから API Designer を開始するときに、一時環境変数を渡します。

  この方法では、API Designer を開始するたびに以下のコマンドを実行する必要があります。

  APIC_DESIGNER_CREDENTIALS=<designer_credentials_file_path>/designer_credentials.json open <designer_application_file_path>/'API Designer.app'

  ここで、それぞれ以下のとおりです。
  • <designer_credentials_file_path> は、 API Designer 資格情報 JSON ファイルをダウンロードした場所です。
  • <designer_application_file_path> は、 API Designer アプリケーションをダウンロードして解凍した先の場所です。

apic client-creds:clear

Deleted client credentials

資格情報をクリアすることで、不注意で誤った資格情報のセット (例えば、異なる製品リリースや環境からの資格情報) を使用してログインすることを防止します。 API Designer 資格情報をクリアする必要はありません。

apic client-creds:set <path_to_credentials>/credential.json

apic client-creds:set /Users/local_user/credential.json

apic login --server <platform-api-host-name> --sso

https://platform-api.us-east-1.d-r01.apic.cloud.ibm.com/manager

Context? provider

API Manager サーバーにログインしたことを示す確認メッセージが表示されます。

ログアウトするには、以下のコマンドを実行します。

apic logout --server <api-manager-host-name>

Successfully logged out of <api-manager-host-name>