Wiki source code of Basic API Interface
Last modified by Alex Chang on 2022/04/07 09:11
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | This page explains the Basic REST API for wCloud Service |
| 2 | |||
| 3 | ---- | ||
| 4 | |||
| |
2.1 | 5 | In order to use the our service, all termination devices must obtain an api key. The basic flow is as follows. |
| 6 | |||
| 7 | {{plantuml}}@startuml | ||
| 8 | |||
| 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 | ||
| 11 | |||
| 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 | |||
| 19 | ---- | ||
| 20 | |||
| |
1.1 | 21 | ===== ##Basic Endpoints for API Key and Session Key## ===== |
| 22 | |||
| |
3.1 | 23 | * [[API Key>>API Key]] : **POST /v1/getKey/:uuid** |
| 24 | * [[Session Key>>Session Key]] : **POST /v1/session:apikey** | ||
| |
1.1 | 25 | |
| 26 | ---- | ||
| 27 | |||
| 28 | ===== Revision History ===== | ||
| 29 | |||
| |
2.2 | 30 | (% class="table-bordered" %) |
| |
1.1 | 31 | |=(% style="width: 79px;" %)((( |
| 32 | **Rev** | ||
| 33 | )))|=(% style="width: 623px;" %)((( | ||
| 34 | ((( | ||
| 35 | **Description** | ||
| 36 | ))) | ||
| 37 | )))|=(% style="width: 126px;" %)((( | ||
| 38 | **Date** | ||
| 39 | )))|=(% style="width: 112px;" %)By | ||
| 40 | |(% style="width:79px" %)((( | ||
| 41 | **0.1** | ||
| 42 | )))|(% style="width:623px" %)((( | ||
| 43 | Draft Release | ||
| 44 | )))|(% style="width:126px" %)((( | ||
| 45 | 2019.12.19 | ||
| 46 | )))|(% style="width:112px" %)Alex | ||
| 47 | |(% style="width:79px" %) |(% style="width:623px" %) |(% style="width:126px" %) |(% style="width:112px" %) |