アプリケーションの拡張
アプリケーションの設定 > プログラム拡張 では、アプリケーションに拡張スクリプトを追加できます。
プログラム拡張を利用するには、開発者モードを有効にしておく必要があります。
定数の登録
アクションの拡張プログラム内で、任意の文字(変数名)を実行前に指定した値に置換します。同名の変数は上位が優先されます。
- [+追加]ボタンをクリック
- [編集]ボタン(鉛筆マーク)で、設定欄を表示します
- 変数名(検索する文字)、説明、置換する値を設定します
- [保存]ボタンで、設定内容を保存します。
デフォルト定数
次の定数は、常に利用可能です。
定数 | 説明 | 利用例 |
---|---|---|
{HEXA_API_SERVER} | APIサーバーへのURL | http://{HEXA_API_SERVER}/' + url; |
{HEXA_API_TOKEN} | Bearer から始まる、ログインユーザーのToken | 'Authorization': '{HEXA_API_TOKEN}' |
{HEXA_CLIENT_IP} | ログインしている利用者のグローバルIP |
関数
関数(関数スクリプト)は、アプリケーションごとに追加できる拡張スクリプトです。関数を利用すると、サーバーやコンテナによる管理なしでコードを実行できます。拡張スクリプトを登録後、APIを実行すると当該コードが実行されます。
- [+追加]ボタンをクリック:関数スクリプトエディタを起動して、新しいコードを追加します。
- [編集]ボタン(鉛筆マーク):すでにあるコードを編集できます。
関数スクリプトエディタ
拡張スクリプトを追加・編集できます。
追加・編集時には、関数名と関数IDを指定します。
関数スクリプトのAPI呼出し
エンドポイント
/api/v0/applications/:project-id/functions/:function-id
payload
{
"key1" : "value",
"key2" : "value"
}
指定したpayloadのjson全てが、スクリプトのdata.paramsに渡されます。
response
{
data: {}, // スクリプトでreturnした値が返却されます
erros: [] // スクリプトでエラーが発生した場合エラー内容が返却されます
}