概要
この記事では、POSTMANでAPIを投げるときに出てくる２つのニョロかっこ（正式名称なんて言うんでしょう。英語だとcurly bracketsって呼ばれてるやつです）で囲まれている部分について解説します。
Image may be NSFW.
Clik here to view.
なるべく一般的な説明にできるよう心がけますが、具体例として、Automation Anywhere の IQ Botに投げるAPIを上げているので、Automation AnywhereやIQ Bot向けの説明も入り込むことをご了承ください。
ズバリ！
２つのニョロかっこで囲まれた文字。
それはAPIの「変数」です。
詳しく解説
このページの最初に出ているイメージは、Automation Anywhere のクラウド版から認証トークンを取得するAPIです。
クラウド版には製品版、フリートライアル版、コミュニティエディションなどいくつか種類がありますが、どれに対しても共通のAPIを投げることができます。
上記を例に、具体的に解説していきます。
{{hoge}}は変数なので、具体的な値に置き換えてもOK
エンドポイント部分は{{serverURL}}/v1/authenticationとなっていますね。
この{{serverURL}}の部分は、このまま変数にしておいてもいいし、具体的なサーバー名に置き換えても大丈夫です。
例えばコミュニティエディションの場合、ダッシュボードのURLはhttps://community.cloud.automationanywhere.digital/#/homeとなっています。
Image may be NSFW.
Clik here to view.
ここから/#/homeを除いたhttps://community.cloud.automationanywhere.digitalが、{{serverURL}}に入るべき中身です。
なのでコミュニティエディションの場合、POSTMANからPOSTするエンドポイントの中身を以下のように書き換えても大丈夫ということです。
https://community.cloud.automationanywhere.digital/v1/authentication
Image may be NSFW.
Clik here to view.
製品版やフリートライアル版でも、要領は同じです。
ダッシュボードを表示させたときのURLから/#/homeを除いたものが{{serverURL}}に入るべきサーバーのURLです。
※フリートライアルやコミュニティエディションでは、トークンを取得するAPIは問題なく投げられますが、それ以外の実際の処理をするAPIは制限がかかっている場合があります。
変数部分を変数として使うためには、Environmentで変数の定義をする
上記のように、サンプルのエンドポイントの{{hoge}}部分を直接置き換えることもできますが、そのまま変数として残しておくこともできます。
変数として使う場合は、変数をEnvironmentで定義しておく必要があります。
POSTMANのEnvironmentについては、こちらの記事をご参照ください。
