safesight-control/docs/api-third-party.md

310 lines
21 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

**220视觉识别集成方案**
**1、告警图片上传**
项目文件存储采用MinIO参数如下
服务地址http://180.51.12.14:9000(甲方未来有IP变更可能需要做成可配置)
bucketName: vi
accessKey: admin
secretKey: 12345678aA
**2、V6平台登录接口**
+-------------+---------------------------------------+---------------+
| 提供方 | V6平台 | |
+-------------+---------------------------------------+---------------+
| 调用方 | 数字孪生 | |
+-------------+---------------------------------------+---------------+
| 集成方式 | http POST请求 | |
+-------------+---------------------------------------+---------------+
| 调用方式 | 孪生平台在 | |
| | 初次进入页面时调用过期时间为30分钟 | |
+-------------+---------------------------------------+---------------+
| 集成地址 | http://180.51.12.14/api/appsys/ss | 建议地址 |
| | o/httpheader/login/v1?username\_=szls | 做成可配置的 |
+-------------+---------------------------------------+---------------+
| **请求头h | | |
| eader参数** | | |
+-------------+---------------------------------------+---------------+
| 参数名 | 参数值 | |
+-------------+---------------------------------------+---------------+
| username\_ | digital | |
+-------------+---------------------------------------+---------------+
| 请求响应 | { | |
| | | |
| |     \"errorDesc\": null, | |
| | | |
| |     \"message\": null, | |
| | | |
| |     \"responseBody\": { | |
| | | |
| |         \"userInfo\": { | |
| | | |
| |             \"avatar\": null, | |
| | | |
| |             \"consoleType\": \"1\", | |
| | | |
| |             \"currentAppId\": \"1\", | |
| | | |
| |             \"currentDeptId\": | |
| | \"8a7465ff8ced991f018de9dae1591594\", | |
| | | |
| |             \"currentLanguageCode\": | |
| | \"zh_CN\", | |
| | | |
| |             \"currentOrgId\": | |
| | \"ORG_ROOT\", | |
| | | |
| |             \"deptName\": | |
| | \"精密铸造厂\", | |
| | | |
| |             \"id\": | |
| | \"8a746b7d91deb3270191df35f42e000e\", | |
| | | |
| |             \"realname\": \"szls\", | |
| | | |
| |             \"sanyEnable\": false, | |
| | | |
| |             \"sanyRoleCodes\": \[\], | |
| | | |
| |             \"secretLevel\": \"1\", | |
| | | |
| |             \"secretLevelName\": | |
| | \"非涉密人员\", | |
| | | |
| |             \"username\": \"szls\" | |
| | | |
| |         }, | |
| | | |
| |         \"expireTime\": \"18000\", | |
| | | |
| |         \"accessKey\": { | |
| | | |
| |             | |
| | \"AVI | |
| | CIT_PT6_APP_USER_ACCESS_KEY_SECRET\": | |
| | \"3aaf | |
| | 0b284aaf77141e71b02833fa978158baff378 | |
| | e210cc16db51e438d8c9a1b2f64d6faec5088 | |
| | 0abdac4d94e1f238830dc2bc0b831996de286 | |
| | 7760ed583065437f4137f62584bd4b62af6bc | |
| | e2f44b1b639ad0862a1ecbbadd307b54c814e | |
| | 554688f92da67789f8312e676eff53116c56e | |
| | 669e887163e7584dedc0ce313a4402c890027 | |
| | 46902b746e2971e94bf9e962b61c823d6a03b | |
| | 7d517b8cad138d318959e79ddce0483822df3 | |
| | 7393fefa1de230196b3d5b2e62b3006e95411 | |
| | 7e931bc9fcd2efaec59197f26f3d85d52a\", | |
| | | |
| |             | |
| | \ | |
| | "AVICIT_PT6_APP_USER_ACCESS_KEY_ID\": | |
| | \"FY2ePr%2Fh4JEs9VQduFk4yPo8f27tmox | |
| | GendR8YQgWClmxo%2F454KmWddfXOR2bcuL\" | |
| | | |
| |         }, | |
| | | |
| |         \"refreshTime\": \"72000\", | |
| | | |
| |         \"licenseAlertMsg\": null, | |
| | | |
| |         \"token\": | |
| | \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N | |
| | iJ9.eyJzdWIiOiJBcHDliY3nq6_mjojmnYMiL | |
| | CJBUFBfSUQiOiIxIiwiQVZJQ0lUX1BUNl9BUF | |
| | BfVVNFUl9BQ0NFU1NfS0VZX0lEIjoiRlkyZVB | |
| | yJTJGaDRKRXM5VlFkdUZrNHlQbzhmMjd0bW94 | |
| | R2VuZFI4WVFnV0NsbXhvJTJGNDU0S21XZGRmW | |
| | E9SMmJjdUwiLCJpc3MiOiJBVklDLURJR0lUQU | |
| | wiLCJJU1NVRURfVElNRVNUQU1QIjoiMTcyNjA | |
| | yNjc5NDAwMiIsIlVTRVJfTkFNRSI6InN6bHMi | |
| | LCJhdWQiOiI4YTc0NmI3ZDkxZGViMzI3MDE5M | |
| | WRmMzVmNDJlMDAwZSIsIlVTRVJfQ09ERSI6In | |
| | N6bHMiLCJMQU5HVUFHRV9DT0RFIjoiemhfQ04 | |
| | iLCJVU0VSX0RFUFRfQ09ERSI6IjQxMTAwMCIs | |
| | IlRPS0VOX1RZUEUiOiJhY2Nlc3MiLCJVU0VSX | |
| | 0RFUFRfTkFNRSI6IueyvuWvhumTuOmAoOWOgi | |
| | IsImV4cCI6MTcyNjA0NDc5NCwiT1JHX0lERU5 | |
| | USVRZIjoiT1JHX1JPT1QiLCJVU0VSX0RFUFRf | |
| | SUQiOiI4YTc0NjVmZjhjZWQ5OTFmMDE4ZGU5Z | |
| | GFlMTU5MTU5NCIsIlNFQ1JFVF9MRVZFTCI6Ij | |
| | EiLCJqdGkiOiJmNjE5OWE3NC02ZWVhLTRmYjA | |
| | tYTE2Zi0yNzA3MTQzMGM2OTMifQ.-dAzs2RIB | |
| | Ai99odaaGOpwHt61tzeLwNrOiXNPK4Z-VY\", | |
| | | |
| |         \"refreshToken\": | |
| | \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N | |
| | iJ9.eyJzdWIiOiJBcHDliY3nq6_mjojmnYMiL | |
| | CJBUFBfSUQiOiIxIiwiQVZJQ0lUX1BUNl9BUF | |
| | BfVVNFUl9BQ0NFU1NfS0VZX0lEIjoiRlkyZVB | |
| | yJTJGaDRKRXM5VlFkdUZrNHlQbzhmMjd0bW94 | |
| | R2VuZFI4WVFnV0NsbXhvJTJGNDU0S21XZGRmW | |
| | E9SMmJjdUwiLCJpc3MiOiJBVklDLURJR0lUQU | |
| | wiLCJJU1NVRURfVElNRVNUQU1QIjoiMTcyNjA | |
| | yNjc5NDAwMiIsIlVTRVJfTkFNRSI6InN6bHMi | |
| | LCJhdWQiOiI4YTc0NmI3ZDkxZGViMzI3MDE5M | |
| | WRmMzVmNDJlMDAwZSIsIlVTRVJfQ09ERSI6In | |
| | N6bHMiLCJMQU5HVUFHRV9DT0RFIjoiemhfQ04 | |
| | iLCJVU0VSX0RFUFRfQ09ERSI6IjQxMTAwMCIs | |
| | IlRPS0VOX1RZUEUiOiJyZWZyZXNoIiwiVVNFU | |
| | l9ERVBUX05BTUUiOiLnsr7lr4bpk7jpgKDljo | |
| | IiLCJleHAiOjE3MjYwOTg3OTQsIk9SR19JREV | |
| | OVElUWSI6Ik9SR19ST09UIiwiVVNFUl9ERVBU | |
| | X0lEIjoiOGE3NDY1ZmY4Y2VkOTkxZjAxOGRlO | |
| | WRhZTE1OTE1OTQiLCJTRUNSRVRfTEVWRUwiOi | |
| | IxIiwianRpIjoiNTQ5MGRmZDAtYWYzYS00M2E | |
| | yLWI5ZmUtM2JmZGM4YzE5ZTFjIn0.7B40GSCW | |
| | AFlQl01PSYkh4H478F8cD4-vqH5SZU8s7DQ\" | |
| | | |
| |     }, | |
| | | |
| |     \"retCode\": \"200\" | |
| | | |
| | } | |
+-------------+---------------------------------------+---------------+
| 取值字段 | responseBody.token | 用作其他请 |
| | | 求请求头参数 |
+-------------+---------------------------------------+---------------+
**3、告警事件信息同步**
+-------------+----------------+-----------------+---+---------------+
| 提供方 | V6平台 | | | |
+-------------+----------------+-----------------+---+---------------+
| 调用方 | 视觉识别 | | | |
+-------------+----------------+-----------------+---+---------------+
| 集成方式 | http POST请求 | | | |
+-------------+----------------+-----------------+---+---------------+
| 调用方式 | 当 | | | |
| | 告警事件发生时 | | | |
| | 调用token过 | | | |
| | 期时间为30分钟 | | | |
+-------------+----------------+-----------------+---+---------------+
| 集成地址 | http://180.51. | | | 建议地址 |
| | 12.14/api/edge | | | 做成可配置的 |
| | /edgecallmanag | | | |
| | es/vi-alarm/v1 | | | |
+-------------+----------------+-----------------+---+---------------+
| **请求头h | | | | |
| eader参数** | | | | |
+-------------+----------------+-----------------+---+---------------+
| 参数名 | 参数值 | | | |
+-------------+----------------+-----------------+---+---------------+
| X-A | 从登录接 | | | |
| ccess-Token | 口获取的respon | | | |
| | seBody.token值 | | | |
+-------------+----------------+-----------------+---+---------------+
| 请求包体 | { | | | |
| | | | | |
| | \"tenantCode | | | |
| | \":\"租户号\", | | | |
| | 0325新添加 | | | |
| | | | | |
| | \"channelNo | | | |
| | \":\"频道号\", | | | |
| | | | | |
| | \"a | | | |
| | larmContent\": | | | |
| | \"人员到岗\", | | | |
| | | | | |
| | \"alarmTime\": | | | |
| | \"告警时间\", | | | |
| | | | | |
| | \ | | | |
| | "personName\": | | | |
| | \"人员名称\", | | | |
| | | | | |
| | \"meetLevel\": | | | |
| | \"相识度\", | | | |
| | | | | |
| | \"picInfo\": | | | |
| | \[ | | | |
| | | | | |
| | {\"url\": | | | |
| | \"http地址\"}, | | | |
| | | | | |
| | {\"url\": | | | |
| | \"http地址\"} | | | |
| | | | | |
| | \], | | | |
| | | | | |
| | \"videoInfo\": | | | |
| | \[ | | | |
| | | | | |
| | {\"url\": | | | |
| | \"http地址\"}, | | | |
| | | | | |
| | {\"url\": | | | |
| | \"http地址\"} | | | |
| | | | | |
| | \] | | | |
| | | | | |
| | } | | | |
+-------------+----------------+-----------------+---+---------------+
| 参数说明 | | | | |
+-------------+----------------+-----------------+---+---------------+
| channelNo | | 频道号 | | |
+-------------+----------------+-----------------+---+---------------+
| a | | 告警内容 | | |
| larmContent | | | | |
+-------------+----------------+-----------------+---+---------------+
| alarmTime | | 告警时间 | \ | |
| | | | " | |
| | | | 2 | |
| | | | 0 | |
| | | | 2 | |
| | | | 4 | |
| | | | - | |
| | | | 0 | |
| | | | 1 | |
| | | | - | |
| | | | 0 | |
| | | | 1 | |
| | | | 0 | |
| | | | 9 | |
| | | | : | |
| | | | 0 | |
| | | | 0 | |
| | | | : | |
| | | | 0 | |
| | | | 0 | |
| | | | \ | |
| | | | " | |
+-------------+----------------+-----------------+---+---------------+
| picIn | | 图片地址结合 | | |
| fo\[0\].url | | | | |
+-------------+----------------+-----------------+---+---------------+
| vide | | 视频地址集合 | | |
| oInfo\[0\]. | | | | |
| url | | | | |
+-------------+----------------+-----------------+---+---------------+
| | | | | |
+-------------+----------------+-----------------+---+---------------+
| 响应包体 | { | | | |
| | | | | |
| | \"respons | | | |
| | eBody\":\"1\", | | | |
| | | | | |
| | \"message\": | | | |
| | null, | | | |
| | | | | |
| | \"retCode\": | | | |
| | \"200\", | | | |
| | | | | |
| | \"errorDesc\": | | | |
| | null | | | |
| | | | | |
| | } | | | |
+-------------+----------------+-----------------+---+---------------+
**4、监控视频合流web视频直播地址**
**5、监控视频单流web视频直播地址列表**
**6、镜像内程序文件存放地址**
为更新便捷性考虑程序以及配置文件做成挂接到k8s外nfs形式需要给出镜像内程序文件夹路径