應用 API
簡介
應用API包括:
- 使用者應用查詢 API
- 使用者表單查詢 API
開發前,請仔細閱讀開發指南。
附註:
以下所有 API路徑中的 app_id 和 entry_id 分別表示應用 ID 和該應用內的表單 ID,因此 app_id+entry_id 表示全局唯一的表單 ID。
API類型
使用者應用查詢API
僅取得 API Key 當中應用授權範圍內的應用資訊。
請求地址:https://api.jodoo.com/api/v5/app/list
請求頻率:30 次/秒
請求方式:POST
請求參數:
參數 | 類型 | 必需 | 說明 |
limit | Number | 否 | 單次取數的資料條數,1~100,預設 100。 |
skip | Number | 否 | 需要跳過的資料條數,預設 0 。 |
參數釋義:
- 目的:想要查詢資料庫中第 500~599 的資料;
- 分析:查詢的資料條數為 100 條;需要跳過的資料條數為 499;
- 參數:那麼請求參數 skip 可以設定為:499;limit 設定為100
回應內容:
參數 | 含義 |
apps | 應用資訊 |
apps[].name | 應用名稱 |
apps[].app_id | 應用id |
回應範例:
{
"apps": [
{
"name": "應用名稱1",
"app_id": "5d5a5bbb850a6d0604ab119"
},
{
"name": "應用名稱2",
"app_id": "5d5a5c14850a6d0604ab11a4"
}
]
}
使用者表單查詢API
取得當前應用下所有表單資訊。
API版本說明:
請求地址:https://api.jodoo.com/api/v5/app/entry/list
請求頻率:30 次/秒
請求方式:POST
請求參數:
參數 | 類型 | 必需 | 說明 |
app_id | String | 是 | 應用ID。 |
limit | Number | 否 | 單次取數的資料條數,1~100,預設 100。 |
skip | Number | 否 | 需要跳過的資料條數,預設 0 。 |
{
"app_id": "5e0dca0cc9a2790006c11e02"
}
回應內容:
參數 | 含義 |
forms | 表單資訊 |
forms[].name | 表單名稱 |
forms[].app_id | 應用id |
forms[].entry_id | 表單id |
回應範例:
{
"forms": [
{
"name": "表單名稱1",
"app_id": "5e0dca0cc9a2790006c11e02",
"entry_id": "56fcab0f02c4675e3fe9694a"
},
{
"name": "表單名稱2",
"app_id": "5e0dca0cc9a2790006c11e02",
"entry_id": "5ed750af3c07c70f9c6eef78"
}
]
}