Changes for page Basic API Interface
Last modified by Alex Chang on 2022/04/07 09:11
edited by Alex Chang
on 2022/03/18 13:57
on 2022/03/18 13:57
edited by Alex Chang
on 2022/04/07 09:11
on 2022/04/07 09:11
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -2,16 +2,32 @@ 2 2 3 3 ---- 4 4 5 - =====##BasicEndpointsforAPIKeyandSessionKey##=====5 +In order to use the our service, all termination devices must obtain an api key. The basic flow is as follows. 6 6 7 -* [[API Key>>getapikey|API Key]] : **POST /v1/getKey/:uuid** 8 -* [[Session Key>>getsessionkey|Session Key]] : **POST /v1/session:apikey** 7 + {{plantuml}}@startuml 9 9 9 +client-->"api Server": Get API key with a unique key(MAC Address)\n ==>https://{api server ip}/v1/getKey/:uuid 10 +"api Server"->client: return api key and secret 10 10 12 +client->client:APP save\n- SERVICE_CODE\n- API KEY\n- API SECRET 13 + 14 +client-->"api Server": Get a session key\n ==>https://{api server ip}/v1/session/:apikey 15 +"api Server"->client: return a session key and expired date 16 + 17 +@enduml{{/plantuml}} 18 + 11 11 ---- 12 12 21 +===== ##Basic Endpoints for API Key and Session Key## ===== 22 + 23 +* [[API Key>>API Key]] : **POST /v1/getKey/:uuid** 24 +* [[Session Key>>Session Key]] : **POST /v1/session:apikey** 25 + 26 +---- 27 + 13 13 ===== Revision History ===== 14 14 30 +(% class="table-bordered" %) 15 15 |=(% style="width: 79px;" %)((( 16 16 **Rev** 17 17 )))|=(% style="width: 623px;" %)(((