外部のアプリからアクションを実行することができます。以下のこれを行う方法を説明します。
準備
Gravioサーバーをインストールして起動してください。 Gravio Studioを使用して、実行するアクションを作成します。
- API *
- API名:
run action api
*プロトコル:
https (port 29443)
*エンドポイント:
/runaction
*引数:
action id
と variables
をこの形式で含むJSONドキュメント:
{
"actionid": "16c3d181-8a05-4356-b7af-5b9a12965de4",
"variables": {"var1": "string", "var2": 1234}
}
variables
は、 av.
という接頭辞を持つアクション変数としてActionに渡されます。変数を受け入れるためにGravioのアクションも設定していることを確認してください。設定方法の詳細は、 アクション内で利用できる変数
例
actionid
と variables
はJSONドキュメントに入ります。実行後のレスポンスは 緑部分 以下です。エラーが発生した場合は、エラー内容が返されます。要求が成功した場合、変数は使用可能です
リクエスト:
POST http://127.0.0.1:8282/action HTTP/1.1
Content-Length: 36
Content-Type: application/json; charset=utf-8 Host: 127.0.0.1:8282
Connection: Keep-Alive
Pragma: no-cache
{
"actionid": "16c3d181-8a05-4356-b7af-5b9a12965de4",
"variables": {"var2": 99999, "var1": "This is a value from the API."}
}
応答:
HTTP/1.1 200 OK
Content-Length: 9
Content-Type: application/json; charset=utf-8
Server: Microsoft-HTTPAPI/2.0
Set-Cookie: __NCTRACE=7efbeeac-8e01-4dec-971d-87d1555b5a88; path=/; expires=Mon, 09- Apr-2018 07:10:42 GMT; HttpOnly
Date: Mon, 09 Apr 2018 06:40:42 GMT
“Success”
- APIのテスト方法*
- Postmanというツールを使用してAPIを呼び出すことをお勧めします。 Postmanはhttps://www.getpostmanから無料でダウンロードできます。
POST
リクエストを作成する- URLを入力してください:
https://x.x.x.x:29443/runaction
- Pickメソッド
raw
- Pickメソッド
application/json
*本文に、アクションの
JSON
文字列を入力します。 Gravio Studioのアクション概要ページからアクションIDを取得できます。
*入力変数を出力するアクションを作成します。たとえば Slackチャンネルなど:
トラブルシューティング
*受信側コンピュータにファイアウォールが有効になっていないことを確認します。
- GravioサーバーとPostmanの両方が同じネットワークにあることを確認してください。
- Gravioサービスが実行されていることを確認する
*有効な
JSON
を渡していることを確認してください。
*変数がGravioのアクションで設定されていることを確認する
Gravio Serverを再起動してみてください