文件 API
開發準備
開發前,請仔細閱讀開發指南。
文件 API
獲取文件上傳憑證和上傳地址 API
獲取文件上傳憑證和上傳地址 API
請求地址:https://api.jodoo.com/api/v5/app/entry/file/get_upload_token
請求頻率:20 次/秒
請求方式:POST
API 說明:
每次請求會獲取 100 個文件上傳憑證和上傳地址,上傳的文件會與 transaction_id 綁定,只有相同 transaction_id 的建立或修改請求才能使用該文件。
請求參數:
參數 | 類型 | 必需 | 說明 |
app_id | String | 是 | 應用 ID |
entry_id | String | 是 | 表單 ID |
transaction_id | String | 是 | 事務 ID 附註:此參數需使用者自己生成,推薦使用 UUID 格式。 |
請求資料樣例:
{
"app_id": "59264073a2a60c0c08e20bfb",
"entry_id": "59264073a2a60c0c08e20bfd",
"transaction_id": "87cd7d71-c6df-4281-9927-469094395677" //事務ID
}
回應內容:
參數 | 類型 | 說明 |
token_and_url_list | JSON | 文件上傳憑證和上傳地址 |
token_and_url_list[].url | String | 文件上傳地址 |
token_and_url_list[].token | String | 文件上傳憑證 |
回應示例:
{
"token_and_url_list": [
{
"url": "https://upload.qiniup.com",
"token": "bM7UwVPyBBdPaleBZt21SWKzMy2qPUpn-05jZlas:ELIqACNut-t52UMPD-DZNrX8hTU=:eyJmc2l6ZU1pbiI6MSwiZnNpemVMaW1pdCI6MjA5NzE1MjAwLCJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24vanNvbiIsImNhbGxiYWNrQm9keSI6IntcImFwcElkXCI6XCI2MWFjNzcxNTE0MjU3NDM2ODhlZWMwYzRcIixcImVudHJ5SWRcIjpcIjYxYWM3NzNhMTQyNTc0MzY4OGVlYzBjN1wiLFwia2V5XCI6XCIkKGtleSlcIixcImhhc2hcIjpcIiQoZXRhZylcIixcIm5hbWVcIjpcIiQoZm5hbWUpXCIsXCJzaXplXCI6XCIkKGZzaXplKVwiLFwibWltZVwiOlwiJChtaW1lVHlwZSlcIixcImJ1Y2tldFwiOlwiamR5LWZpbGVcIixcInVwbG9hZGVyXCI6XCI2MTFhMmQzNjRmMzQ3MDAwMDY3NWM5ZGRcIixcInNlc3Npb25JZFwiOlwic3NkXCJ9IiwiY2FsbGJhY2tIb3N0IjoiNTA3NS0xMTQtMjI0LTE3LTIxNi5uZ3Jvay5pbyIsImNhbGxiYWNrVXJsIjoiaHR0cDovLzUwNzUtMTE0LTIyNC0xNy0yMTYubmdyb2suaW8vZmlsZS91cGxvYWQvYXBpX2NhbGxiYWNrIiwiZm9yY2VTYXZlS2V5Ijp0cnVlLCJzYXZlS2V5IjoiYTJjOTkwY2ItMTlhZS00NDgwLTkyYzYtZDI3N2I5ZGQ2MmFhIiwic2NvcGUiOiJkbi1qZHktdXBsb2FkIiwiZGVhZGxpbmUiOjE2Mzk0ODU2NjV9"
},
{
"url": "https://upload.qiniup.com",
"token": "bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:inKpUPPCKIWJ6CnZzHrRPnjXwio=:eyJmc226ZU1pbiI6MSwiZnNpemVMaW1pdCI6MjA5NzE1MjAwLCJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24vanNvbiIsImNhbGxiYWNrQm9keSI6IntcImFwcElkXCI6XCI2MWFjNzcxNTE0MjU3NDM2ODhlZWMwYzRcIixcImVudHJ5SWRcIjpcIjYxYWM3NzNhMTQyNTc0MzY4OGVlYzBjN1wiLFwia2V5XCI6XCIkKGtleSlcIixcImhhc2hcIjpcIiQoZXRhZylcIixcIm5hbWVcIjpcIiQoZm5hbWUpXCIsXCJzaXplXCI6XCIkKGZzaXplKVwiLFwibWltZVwiOlwiJChtaW1lVHlwZSlcIixcImJ1Y2tldFwiOlwiamR5LWZpbGVcIixcInVwbG9hZGVyXCI6XCI2MTFhMmQzNjRmMzQ3MDAwMDY3NWM5ZGRcIixcInNlc3Npb25JZFwiOlwic3NkXCJ9IiwiY2FsbGJhY2tIb3N0IjoiNTA3NS0xMTQtMjI0LTE3LTIxNi5uZ3Jvay5pbyIsImNhbGxiYWNrVXJsIjoiaHR0cDovLzUwNzUtMTE0LTIyNC0xNy0yMTYubmdyb2suaW8vZmlsZS91cGxvYWQvYXBpX2NhbGxiYWNrIiwiZm9yY2VTYXZlS2V5Ijp0cnVlLCJzYXZlS2V5IjoiN2Y4Yzk3NDAtNmI2YS00OTQ0LWE0MzgtNjQ1Y2IzN2ViNmQ0Iiwic2NvcGUiOiJkbi1qZHktdXBsb2FkIiwiZGVhZGxpbmUiOjE2Mzk0ODU2NjV9"
},
……
]
}
文件上傳 API
用於上傳文件的 API。
請求地址:{url}
請求頻率: 20 次/秒
請求方式:POST
接口說明:
此處的 url 爲獲取文件上傳憑證和上傳地址 API 中獲取到的上傳地址。
該 API 一個 token 只能上傳一個文件,不允許覆蓋,返回的 key 用於建立和修改接口填寫在附件或圖片控件值中。
請求參數:
參數 | 必需 | 類型 | 說明 |
token | 是 | String | 文件上傳憑證 |
file | 是 | 文件 | 要上傳的文件 |
附註:
1. 由於請求中需要上傳文件,所以參數爲 form-data 形式。
2. file 需要作爲最後一個參數。
回應內容:
參數 | 類型 | 說明 |
key | String | 文件 key |
回應資料樣例:
{
"key": "6b559cf1-b16c-43bd-a211-8fa8fdeae2ef"
}
注意事項
1. token 的有效時間爲一小時。
2. transaction_id 和 key 配合使用,transaction_id 有效時間也爲一小時,失效後,key 也將無法使用。