ジュニパーネットワークス
ソリューション&テクニカル
情報サイト

2021/7/13 - インタラクティブなMist API Documentのご紹介

MistにはAPI操作方法を説明したドキュメント(https://api.mist.com/api/v1/docs/Home)がありますが、
ドキュメントの内容を実際に操作しながら確認できるインタラクティブなドキュメントも存在します。
今回はインタラクティブなドキュメントとしてMist Postman Collectionをご紹介します。

以下、手順をご説明します。
(MistやPostmanのユーザー登録、Postmanクライアントのインストールは省略)

Mist Postman Collectionのインポート

Mist Postman Collection(https://documenter.getpostman.com/view/224925/SzYgQufe)にアクセスし、画面右上の”Run in Postman”をクリックします。

実行環境を選択するダイアログが表示されるのでクライアント版を選択します。
今回はMac版でのご説明ですがWindows版も同様の画面構成です。

ドキュメントのImport先を選択する画面が表示されるのでImportを選択します。

Importが完了するとMist Postman Collectionの認証方法設定画面が表示されます。

認証方法の設定、動作確認

認証方法を設定するため、“Mist Cloud APIs”を選択します。
TypeとしてBasic Authを選択し、Mistコントローラーログイン時のUsername / Passwordを入力しSaveします。

接続先を設定するため、Environmentのorg_idを設定しsaveします。

org_idはMistコントローラーの”Organization” -> “Settings”で確認することが出来ます。

接続を確認するため、“Collections” -> “Orgs” -> “Org” -> “getOrgSettigs”を選択します。
画面右上で先程設定したEnvironmentが選択されていることを確認してください。
“Send”をクリックし画面下にorgの設定が出力されれば接続確認は完了です。

まとめ

今回はMist APIのインタラクティブなドキュメントとしてMist Postman Collectionをご紹介しました。
Mist Postman Collectionは今回ご紹介した以外にも様々なAPI操作を試すことが出来ます。
テスト環境での作業をおすすめしますが、本番環境で試す場合は誤った操作を行わないよう十分ご注意ください。

著者:

技術統括本部 エンタープライズ技術第一本部
システムズエンジニア
北内 薫