Service node to terminal node API
In the Service Node App(SApp)
, call the function of the Terminal node App (NhApp)
through the Java Interface script. The calling format is Json Fomat.Android:
window.AWI.callAppFunc
("JSON Format String")iOS:
prompt
("JSON Format String")Windows:
window.external.callAppFunc
("JSON Format String")SApp - Javascript sample
var sReturn = "{ \"result\":\"FAIL\" }" if(!AWI_ENABLE) return; var joCmd = null; var params = new Object(); params['cmd'] = "newWallet"; // Call api function name joCmd = {func:params}; if(AWI_DEVICE == 'ios') { sReturn = prompt(JSON.stringify(joCmd)); } else if(AWI_DEVICE == 'android') { sReturn = window.AWI.callAppFunc(JSON.stringify(joCmd)); } else { // windows sReturn = window.external.CallAppFunc(JSON.stringify(joCmd)); }AWI의 모든 Api는 위와 같은 소스로 호출하고 결과를 JSON Object로 얻어옵니다.
여기서
params['cmd'] = 'value';
로 호출하는 Function name을 전달하고 각 API에 맞는 추가 파라메터params['parameter name'] = 'value';
를 지정하면 사용할 수 있습니다.해당 API들은 Service node web내에 /js/tapp_interface.js 파일로 선언되어 있어 간편하게 호출하여 사용 할 수 있습니다.
AWI API는 다음과 같습니다.
getAPIVersion
Request API version.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getAPIVersion | String | function name |
Request sampleJSON Object |
{ "cmd":"getAPIVersion" } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
version | 1.1.0 | String | API version |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" "version":"1.1.0" } |
getNetID
Request network id.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getNetID | String | function name |
Request sampleJSON Object |
{ "cmd":"getNetID" } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
netID | BizNet, TestNet, DevNet | String | |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" "netID":"BizNet" or "TestNet" or "DevNet" } |
setNetID
Request to save network id.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getNetID | String | function name |
netID | BizNet, TestNet, DevNet | String | |
Request sampleJSON Object |
{ "cmd":"setNetID", "netID":"BizNet" or "TestNet" or "DevNet" } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
netID | BizNet, TestNet, DevNet | String | |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" } |
isAbleTestNet
Request whether able to TestNet.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | isAbleTestNet | String | function name |
Request sampleJSON Object |
{ "cmd":"isAbleTestNet" } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" } |
isAbleDevNet
Request whether able to DevNet.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | isAbleDevNet | String | function name |
Request sampleJSON Object |
{ "cmd":"isAbleDevNet" } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" } |
getConfig
Request saved data.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getConfig | String | function name |
key | key | String | string for key |
Request sampleJSON Object |
{"func": {"cmd":"getConfig", "key":"Key"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
value | Value | String | if result is FAIL, then value is empty. |
Request sampleJSON Object |
{"result":"OK", "value":"Value"} {"result":"FAIL", "value":""} |
setConfig
Request saved data.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setConfig | String | function name |
key | key | String | string for key |
value | value | String | string for value |
Request sampleJSON Object |
{"func": {"cmd":"setConfig", "key":"Key", "value":"Value"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
getAccountConfig
Request saved data related account.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getAccountConfig | String | function name |
key | key | String | string for key |
Request sampleJSON Object |
{"func": {"cmd":"getAccountConfig", "key":"Key"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
value | Value | String | if result is FAIL, then value is empty. |
Request sampleJSON Object |
{"result":"OK", "value":"Value"} {"result":"FAIL", "value":""} |
setAccountConfig
Request to save data related account.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setAccountConfig | String | function name |
key | key | String | string for key |
value | value | String | string for value |
Request sampleJSON Object |
{"func": {"cmd":"setAccountConfig", "key":"Key", "value":"Value"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
setPassword
Request to save password.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setPassword | String | function name |
password | Password | String | password |
Request sampleJSON Object |
{"func": {"cmd":"setPassword", "password”:"Password"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
isSetPassword
Request checking whether the password is stored.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | isSetPassword | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"isSetPassword"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
checkPassword
Request to check password.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | checkPassword | String | function name |
password | Password | String | password |
Request sampleJSON Object |
{"func": {"cmd":"checkPassword", "password":"Password"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
isCheckedPassword
Request checking whether the password is checked.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | isCheckedPassword | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"isCheckedPassword"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
changePassword
Request to change password.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | changePassword | String | function name |
old_password | old Password | String | old Password |
new_password | new password | String | new password |
Request sampleJSON Object |
{"func": {"cmd":"changePassword", "old_password":"Old Password", "new_password":"New Password"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
isAbleFingerprint
Request whether or not fingerprint recognition is possible.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | isAbleFingerprint | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"isAbleFingerprint"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
showFingerprint
Request a fingerprint recognition screen. Fingerprint result is sending by Call
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | showFingerprint | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"showFingerprint"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} |
setTerminatePath
request to save path for closing application by back button double click.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setTerminatePath | String | function name |
path | path | String | path in host |
Request sampleJSON Object |
{ "func":{ "cmd":"setTerminatePath", "path":"/index" // for finish app by double click } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} |
logout
Request to initialize check password information. The user must login again.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | logout | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"logout"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} |
getServiceList
Request service data(service list include service id, service name, ...).
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setServiceList | String | function name |
Request sampleJSON Object |
{ "func":{ "cmd":"getServiceList" } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
imageFolder | path | String | saved image path in mobile |
list | list | String | service item list |
serviceId | String | service id | |
serviceName | String | service name | |
active | String | Y / N | |
pageNum | page index | int | |
seqNum | icon index | int | |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" "imageFolder":"/data/user/0/{pakage name}/files" "list":[ { "serviceId":"id", "serviceName":"name", "active":"Y" "pageNum:0, "seqNum:0 }, { ... } ] } |
setServiceList
Request to save data(service list include service id, service name, ...).
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setServiceList | String | function name |
callType | launcher or "" | String | laucher is not save image "" is save image by imgPath |
list | list | String | service item list |
serviceId | String | service id | |
serviceName | String | service name | |
imgPath | image path in servie node | String | image path for save |
active | String | Y / N | |
pageNum | page index | int | |
seqNum | icon index | int | |
Request sampleJSON Object |
{ "func":{ "cmd":"setServiceList", "callType":"launcher", or "" "list":[ { "serviceId":"id", "serviceName":"name", "imgPath":"full path", "active":"Y", "pageNum":0, "seqNum":0 }, { ... } ] } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
getLocalHttpHost
Request ip and port in mobile.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getLocalHttpHost | String | function name |
Request sampleJSON Object |
{ "func":{ "cmd":"getLocalHttpHost" } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
ip | 127.0.0.1 | String | ip in mobile |
port | 8050 | String | mobile in mobile |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" "ip":"127.0.0.1" "port":"8050" } |
openServiceApp
Request to open service app.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | openServiceApp | String | function name |
serviceId | service id | String | service id to open |
Request sampleJSON Object |
{ "func":{ "cmd":"openServiceApp", "serviceId":"service ID" } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{ "result":"OK" or "FAIL" } |
closeServiceApp
Close opened service App.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | closeServiceApp | String | function name |
isLauncher | Y, N, empty | String | If value is N or empty, then go to first page. |
Request sampleJSON Object |
{ "func":{ "cmd":"closeServiceApp", "isLauncher":"Y" or "N", empty } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK | String | |
Request sampleJSON Object |
{"result":"OK"} |
openAppByHost
Request to open host.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | openAppByHost | String | function name |
host | http://127.0.0.1:8080 | String | host to open app |
Request sampleJSON Object |
{ "func":{ "cmd":"openAppByHost", "host":"http://127.0.0.1:8080" } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
newWallet
Request to create new wallet.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | newWallet | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"newWallet"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
walletId | String | if result is FAIL, then wallet id is empty. | |
Request sampleJSON Object |
{"result":"OK", "walletId":"wallet id"} {"result":"FAIL", "walletId":""} |
deleteWallet
Request to delete wallet. Show wallet backup view to save paper wallet if
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | deleteWallet | String | function name |
walletId | Wallet Id | String | wallet id for delete |
Request sampleJSON Object |
{"func": {"cmd":"deleteWallet", "walletId" : "Wallet Id" }} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
backup
Request to show wallet backup view. Show the wallet's mnemonic in order so that the user can keep it separately, then take the input again and check it.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | backup | String | function name |
walletId | String | ownd wallet id | |
Request sampleJSON Object |
{"func": {"cmd":"backup", "walletId":"wallet Id"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
restore
Request to show wallet restore view. Enter the mnemonic from the user and restore (register) the Wallet ID (WID). no check password
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | restore | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"restore"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
getWalletList
Request list of wallet in terminal node.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getWalletList | String | function name |
Request sampleJSON Object |
{"func": {"cmd":"getWalletList"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
list | array | String | if result is FAIL, then list is empty. |
walletId | Wallet Id | String | wallet id |
Request sampleJSON Object |
{"result":"OK", "list": [{"walletId":"Wallet ID"}, {...}]} {"result":"FAIL", "list": []} |
getSignature
Request a signing key and public key for coin transfer from the web. (except transation function)
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setAccountConfig | String | function name |
walletId | wallet id | String | sender owned wallet |
args | argument array | String [] | protocol argument array |
PID | String | protocol Id | |
PVER | String | protocol Version | |
Arg1, 2 ~ N | String | arguments for transaction | |
Nonce | String | nonce of Previous transaction | |
args | argument | String | protocol argument (optional) for pcwallet. |
Request sampleJSON Object |
{ "cmd":"getSignature", // command "query_type":"query", or "invoke" // query type "func_name":"xxx", // function name "walletId":"cMggcCKygb..." // wallet id for signature "args":[ // argument list "PID", // PID (protocol id) "PVER", // PVER (protocol version) "arg-1", // argument "arg-2", // argument "...", "arg-n", // argument "nonce" // nonce of signature ] { "cmd":"getSignature", // command "query_type":"query", or "invoke" // query type "func_name":"xxx", // function name "walletId":"cMggcCKygb...", // wallet id for signature "args":"arg" // argument } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
signature_key | String | if result is FAIL, then signature is empty. | |
public_key | String | if result is FAIL, then public key is empty. | |
Request sampleJSON Object |
{ "result":"OK", or "FAIL" "signature_key":"signature key", or "", "public_key":"public key" or "" } |
runTransaction
Request to transaction.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | runTransaction | String | function name |
walletId | String | wallet ID | |
transType | sendCoin, buyContent, … | String | transaction type |
callbackFunc | String | paramet to use after the "sendCoin" function is finished | |
args | argument array | String [] | protocol argument array |
PID | String | protocol Id | |
PVER | String | protocol Version | |
Arg1 | String | argument | |
Arg2 | String | argument | |
… | String | argument | |
ArgN | String | argument | |
displayTitle | title | String | display title in transaction view |
displayDesc | description | String | display desciption in transaction view |
displayArgs | argument array | String | display argument array |
Arg1 | String | argument | |
Arg2 | String | argument | |
… | String | argument | |
ArgN | String | argument | |
displayFee | fee | String | Fee required for transaction (optional) |
Request sampleJSON Object |
{ "func":{ "cmd":"runTransaction", // command "walletId":"cMggcCKygb..." // sending wallet id "transType":"sendCoin" // transaction type (sendCoin, registerWallet ...) "callbackFunc":"fnCallback", // callback function name "args":[ "PID", "PVER", "arg-1", "arg-2", "...", "arg-n" // argument listoptional ], "displayTitle":"Send Coin" // title in transaction view "displayDesc":"send coin to other" // description in transaction view "displayArgs":[ "display arg-1", // optional "display arg-2", // optional "...", // optional "display arg-n" // optional ], "displayFee":700 // optional } } |
||
Request sample - sendCoin JSON Object |
{ "cmd":"runTransaction", "transType":"sendCoin", "callbackFunc":"FnCallBackTransferCoin", "walletId":"ZqriytCRFQ...", "args":[ "PID", // PID (protocol id) "10000", // PVER (protocol version) "ZqriytCRFQ...", // sending wallet id "ZqqoPVqDBk...", // receiving wallet id "R", // basis coin(S/R, S:send coin based) 1000, // sending amount (long) "coin transaction", // transaction memo "", // sending Memo "" // receiving Memo ], "displayTitle":"송금확인", "displayArgs":[ "작업테스트:송금테스트", "메모2:화이팅" ], "displayFee":0 // optional } |
||
Request sample - sendToken JSON Object |
{ "cmd":"runTransaction", "transType":"sendToken", "callbackFunc":"FnCallBackTransferToken", "walletId":"ZqrdkyML6F...", "args":[ "PID", // PID (protocol id) "10000", // PVER (protocol version) "xxx...", // token id "1000", // sending amount (long) "ZqqoPVqDBk...", // receiving wallet id "receiving memo" // receiving memo "sending memo" // sending memo ], "displayTitle":"Token 확인", "displayArgs":[ "작업테스트:Token 보내기", ], "displayFee":700 // optional } |
||
Request sample - registWallet JSON Object |
{ "cmd":"runTransaction", "transType":"registWallet", "callbackFunc":"FnCallBackRegistWallet", "displayTitle":"지갑등록", "displayDesc":"설명", "displayArgs":[ ], "walletId":"ZqrdkyML6F...", "args":[ "PID", // PID (protocol id) "10000", // PVER (protocol version) "pd", // wallet name "nick name", // nick name (owner) "1000000", // daily transfer limits "register" // registration note ], "displayFee":700 // fee } |
||
Request sample - registContent JSON Object |
{ "cmd":"runTransaction", "transType":"registContent", "callbackFunc":"FnCallBackTransferCoin", "walletId":"ZqrdkyML6F...", "args":[ "PID", // PID (protocol id) "10000", // PVER (protocol version) "AAAAA", // data group id "[\"AAAAA\"]", // key "{\"year\":\"2007\",\"price\":\"700\",\"memo\":\"자동차\"}" // data ], "displayTitle":"자동차등록", "displayDesc":"자동차등록", "displayArgs":[ "이름:아무개", "전화번호:032-국회의사당" ], "displayFee":0 // fee } |
||
Request sample - registContentForSale JSON Object |
{ "cmd":"runTransaction", "transType":"registContentForSale", "callbackFunc":"FnCallBackTransferCoin", "walletId":"ZqrdkyML6F...", "args":[ "PID", // PID (protocol id) "10000", // PVER (protocol version) "AAAAA", // data group id "[\"AAAAA\"]", // key "{\"year\":\"2007\",\"price\":\"700\",\"memo\":\"자동차\"}", // data "Title", // title "1100", // price "regist memo" // memo ], "displayTitle":"자동차등록", "displayDesc":"자동차등록", "displayArgs":[ "이름:아무개", "전화번호:032-국회의사당" ], "displayFee":0 // fee } |
||
Request sample - buyContent JSON Object |
{ "cmd":"runTransaction", "transType":"buyContent", "callbackFunc":"FnCallBackBuyContent", "walletId":"ZqrdkyML6F...", "args":[ "PID", // PID (protocol id) "10000", // PVER (protocol version) "bmw520d", // data group id "[\"bmw\"]", // key "buy memo" // memo ], "displayTitle":"자동차구매", "displayDesc":"자동차구매 요청내용입니다", "displayArgs":[ "자동차명: bmw520d", "제조사: bmw", "자동차연식: 2016년식", "자동차구매가: 2050 BON" ], "displayFee":500 // fee } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
transferWebTransactionConfirm
Request to transfer transaction confirm using web itself. A callback function aka transferredWebTransactionConfirm is called. "sendcoin, registContent, registContentForSale" function is used args in parameter, others is not.
Request parameters
name | value | type | discrption |
---|---|---|---|
Request sampleJSON Object |
"{ ""func"":{ ""cmd"":""transferWebTransactionConfirm"", // command ""transType"":""sendCoin"" // transaction type (sendCoin, registerWallet ...) ""walletId"":""cMggcCKygb..."" // sending wallet id ""args"":[ ""PID"", ""PVER"", ""arg-1"", ""arg-2"", ""..."", ""arg-n"" // argument listoptional ], ""callbackFunc"":""fnCallback"", // callback function name } }" |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
transferWebTransaction
Request to transfer transaction using web itself. A callback function aka transferredWebTransaction is called. "sendcoin, registContent, registContentForSale" function is not used args in parameter.
Request parameters
name | value | type | discrption |
---|---|---|---|
Request sampleJSON Object |
{ "func":{ "cmd":"transferWebTransaction", // command "transType":"sendCoin" // transaction type (sendCoin, registerWallet ...) "walletId":"cMggcCKygb..." // sending wallet id "args":[ "PID", "PVER", "arg-1", "arg-2", "...", "arg-n" // argument listoptional ], "callbackFunc":"fnCallback", // callback function name } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
getQRCodeByScan
Request to show QR Code Reader viewer to terminal node. QR Code result is sending by callbackFunc function in argument. if callbackFunc is empty, it called Call AWI_CallFromApp by default.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getQRCodeByScan | String | function name |
callbackFunc | callback function | String | called callback function after calling getQRCodeByScan function. |
Request sampleJSON Object |
{"func": {"cmd":"getQRCodeByScan", "callbackFunc":"receive function"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
showQRCode
Request to show QR Code for wallet Id. QR Code result is sending by Call AWI_CallFromApp function.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | showQRCode | String | function name |
walletId | wallet id | String | wallet id |
walletName | wallet name | String | wallet name |
Request sampleJSON Object |
{"func": {"cmd":"showQRCode", "walletId":"wallet Id", "walletName":"wallet Name"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
getEncryptedText
Request to encrypt text using wallet id to terminal node.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getEncryptedText | String | function name |
walletId | wallet id | String | wallet id to be used for encryption |
plainText | plain text | String | Text to be encrypted |
Request sampleJSON Object |
{"func": {"cmd":"getEncryptedText", "walletId":"Wallet Id", "plainText":"Plain Text"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
value | encrypted Text | String | if result is FAIL, then value is empty. |
Request sampleJSON Object |
{"result":"OK", "value":"encrypted Text"} {"result":"FAIL", "value":""} |
getDecryptedText
Request to decrypt text using wallet id.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getDecryptedText | String | function name |
walletId | wallet id | String | wallet id to be used for encryption |
encryptedText | encrypted Text | String | Text to be decrypted |
Request sampleJSON Object |
{"func": {"cmd":"getDecryptedText", "walletId":"Wallet Id", "encryptedText":"Encrypted Text"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
value | decrypted Text | String | if result is FAIL, then value is empty. |
Request sampleJSON Object |
{"result":"OK", "value":"decrypted Text"} {"result":"FAIL", "value":""} |
callUrl
Show url in other broswer.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | callUrl | String | function name |
host | http://www.google.com | String | url |
Request sampleJSON Object |
{ "func":{ "cmd":"callUrl", "host":"http://www.google.com" } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |
getAppVersion
Get application version.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | getAppVersion | String | function name |
Request sampleJSON Object |
{ "func":{ "cmd":"getAppVersion" } } |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK | String | if get version, the return OK. else return FAIL |
versionName | 0.9.0 | String | version name |
Request sampleJSON Object |
{ "result":"OK", or "FAIL" "versionName":"0.9.0", or "" } |
setAppTitle
Request to change application title.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setAppTitle | String | function name |
title | String | Application Title | |
Request sampleJSON Object |
{"func": {"cmd":"setAppTitle", "title":"Application Title"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK | String | |
Request sampleJSON Object |
{"result":"OK"} |
setAppTitleColor
Request to change application title color.
Request parameters
name | value | type | discrption |
---|---|---|---|
cmd | setAppTitleColor | String | function name |
startColor | #AABBCC | String | Start Color |
endColor | #XXYYZZ | String | End Color, if it is empty, then start color is single color |
orientation | BL_TR, BOTTOM_TOP, BR_TL, LEFT_RIGHT, RIGHT_LEFT, TL_BR, TOP_BOTTOM, TR_BL |
String | if end color is not empty, set gradient orientation |
Request sampleJSON Object |
{"func": {"cmd":"setAppTitleColor", "startColor":"Start Color", "endColor":"End Color", "orientation":"Orientation"}} |
Result parameters
name | value | type | discrption |
---|---|---|---|
result | OK, FAIL | String | |
Request sampleJSON Object |
{"result":"OK"} {"result":"FAIL"} |