用戶接入

平臺針對用戶提供的能力皆需要通過APPID+AppKey的方式鑒權通過後方可使用，因此使用AIGC視頻和內容生成平臺前，請您準備好平臺賬號。 平臺賬號提供回調地址配置功能，這一功能使得在長時間任務完成時能够通過調用用戶提供的API來完成消息的通知。

賬號介紹

• 賬號開通

  • 目前用戶賬號尚不支持自注册服務，您可以聯繫運營提供您的基礎信息（連絡人/聯繫方式/企業信息等）。由運營開通賬號幷進行相關內容配置。

• 獲取賬號信息

  • 用戶的賬號信息包括基礎信息和資源配置兩部分內容，可以通過我們提供的API接口來實時獲取最新的信息內容。
    • 基礎信息：包括賬戶ID，企業名稱，服務有效期的起止時間以及APPID和AppKey信息。
    • 資源配置：包括可生成人物形象模型總可用量，可生成人物形象模型數總已用量，可生成TTS個人音色模型數總可用量，可生成TTS個人音色模型數總已用量，可生成視頻時長總可用量，可生成視頻時長總已用量，人物形象模型最大幷發任務數總可用量，人物形象模型最大幷發任務數總已用量，TTS個人音色模型生成最大幷發任務數總可用量，TTS個人音色模型生成最大幷發任務數總已用量，視頻生成最大幷發任務數總可用量，視頻生成最大幷發任務數總已用量等信息。

• 用戶鑒權

  • 平臺提供爲各系統在身份合法性校驗環節獲取令牌的接口。通過appId、時間戳、appKey加密生成得到的簽名來完成用戶鑒權，鑒權通過即可使用相關服務。
  • 用戶調用平臺全部API服務，皆需要訪問服務接入點：aigc.softsugar.com，幷在請求頭中加上token信息（token通過appId、時間戳、appKey加密生成得到的簽名【MD5（appId+時間戳+appKey）】，MD5結果取32位小寫值。後續接口都需要加上該token進行請求，添加方式爲 Header: Authorization: Bearer {token}）。

API 說明

三方系統接入登錄

接口描述

用來爲各系統在身份合法性校驗環節獲取令牌的接口。通過appId、時間戳、appKey加密生成得到的簽名【MD5（appId+時間戳+appKey）】，MD5結果取32位小寫值。 調用HTTP接口都需要加上該token進行請求，添加方式爲 Header: Authorization: Bearer {token}。 調用WebSocket接口都需要加上該token進行請求，添加方式爲 Header: Authorization: Bearer {token}或者在URL中拼接，Header中傳遞的token具有更高優先級。

請求地址

POST /api/uc/v1/access/api/token

請求頭

Content-Type: application/json

請求參數

JSON數組格式，數組中對象的字段定義如下：

字段	類型	必填	描述
appId	String	True	app id （用戶接入鑒權使用ID）
timestamp	String	True	當前時間戳，精確到毫秒
sign	String	True	生成的簽名（MD5計算後的值轉成十六進制字符串的形式，注意每個字節轉換後的位數如果不足，請前面補零）
grantType	String	True	認證類型(固定值‘sign’)

請求樣例

{
  "appId": "ID",
  "timestamp": "1676797061518",
  "sign": "c4b08ca7d242939b8bf9c1dbb1a1911a",
  "grantType": "sign"
}

響應元素

字段	類型	必填	描述
code	Integer	True	0 - 成功, 其他 - 异常
message	String	True	异常詳細信息
data	Object	True	數據對象 ，錯誤返回null
- permissions	Obejct[]	True	權限對象數組
- roles	Obejct[]	True	角色對象數組
- accessToken	String	True	訪問憑證，默認有效期8小時，有效期內多次獲取仍會返回原token
- expiresIn	Integer	True	訪問憑證剩餘生命周期，單位：秒
- refreshToken	String	True	Refresh Token
- refreshTokenExpiresIn	Integer	True	refreshToken剩餘生命周期，單位：秒
- user	Obejct	True	用戶對象信息

permissions

字段	類型	必填	描述
id	Long	True	權限id
appId	Long	True	系統應用id
resourceId	Integer	True	資源 id
action	Integer	True	權限類型 (0: 所有, 1: 創建, 2: 修改 ,3: 删除, 4: 查詢)
creator	Long	True	創建者id
createTime	String	True	創建時間, yyyy-MM-dd HH:mm:ss

roles

字段	類型	必填	描述
id	Long	True	角色id
roleName	String	True	角色名稱
appId	Long	True	系統應用id
description	String	False	描述
isDelete	Integer	True	删除標記 (0: 未删除; 1: 已删除)
creator	Long	True	創建者id
createTime	String	True	創建時間, yyyy-MM-dd HH:mm:ss
updater	Long	True	更新者id
updateTime	String	True	更新時間, yyyy-MM-dd HH:mm:ss

user

字段	類型	必填	描述
id	Long	True	用戶id
userName	String	True	用戶名稱
profilePhoto	String	False	個人照片
company	String	False	公司名稱
companyPhone	String	False	公司電話
companyContact	String	False	公司聯繫地址
status	Integer	True	account status (0: 未開放; 1: 已啓用; 2: 已禁用)
effectiveBeginDate	Date	True	生效開始時間, yyyy-MM-dd HH:mm:ss
effectiveEndDate	Date	True	生效結束時間, yyyy-MM-dd HH:mm:ss
extraInfo	String	False	附加信息
description	String	False	描述
appId	String	True	app id
appKey	String	True	app key
licensePath	String	False	license路徑
isDelete	Integer	True	删除標記 (0: 未删除; 1: 已删除)
creator	Long	True	創建者id
createTime	String	True	創建時間, yyyy-MM-dd HH:mm:ss
updater	Long	True	更新者id
updateTime	String	True	更新時間, yyyy-MM-dd HH:mm:ss

響應樣例

{
    "code": 0,
    "message": "success",
    "data": {
        "permissions": [
			{
                "id": 1,
                "appId": "虛擬人應用",
                "resourceId": 1,
                "action": null,
                "creator": 1,
                "createTime": "2022-05-23 15:12:35"
            }
		],
        "roles": [
            {
                "id": 3,
                "roleName": "企業",
                "appId": 1,
                "description": null,
                "isDelete": 0,
                "creator": 1,
                "createTime": "2022-05-23 15:12:35",
                "updater": 1,
                "updateTime": "2022-05-23 15:12:35"
            }
        ],
        "accessToken": "ZGI3YzRiZmY4ZmFjMjM2MDExODUxNDdmY2MwNGY4OTA0NGRmNGNjYi1jNGNmLTRlMTEtOTExOC05YTU0YTM2NjFjODY",
        "user": {
            "id": 4,
            "userName": "企業1",
            "profilePhoto": null,
            "company": null,
            "companyPhone": null,
            "companyContact": null,
            "status": 1,
            "effectiveBeginDate": null,
            "effectiveEndDate": null,
            "extraInfo": null,
            "description": null,
            "appId": null,
            "appKey": null,
            "licensePath": null,
            "isDelete": 0,
            "creator": 1,
            "createTime": "2022-05-23 15:13:03",
            "updater": 1,
            "updateTime": "2022-05-24 14:26:05"
        }
    }
}

用戶Token刷新

接口描述

主動刷新用戶Access Token，獲取新的Access Token和Refresh Token，重新計算Access Token有效時間。 注意：調用此接口Authorization的參數值應爲Refresh Token。每兩次調用token刷新接口的時間間隔不得低于3小時，否則提示“refresh token過于頻繁,限制間隔3小時”。

請求地址

POST /api/uc/v1/access/api/token/refresh

請求頭

Content-Type: application/json Header: Authorization: Bearer {refresh token}

請求參數

字段	類型	必填	描述
appId	String	True	app id （用戶接入鑒權使用ID）
grantType	String	True	認證類型(固定值‘refreshToken’)

請求樣例

{
  "appId": "APP ID",
  "grantType": "refreshToken"
}

響應元素

字段	類型	必填	描述
code	Integer	True	0 - 成功, 其他 - 异常
message	String	True	异常詳細信息
data	Object	False	數據對象 ，錯誤返回null
- accessToken	String	True	訪問憑證，默認有效期8小時
- expiresIn	Integer	True	訪問憑證剩餘生命周期，單位：秒
- refreshToken	String	True	Refresh Token
- refreshTokenExpiresIn	Integer	True	refreshToken剩餘生命周期，單位：秒

用戶登出

接口描述

用戶登出系統時完成一些緩存信息清理工作。

請求地址

POST /api/uc/v1/web/logout

請求頭

Content-Type: application/json

請求參數

無

請求樣例

無

響應元素

字段	類型	必填	描述
code	Integer	True	0 - 成功, 其他 - 异常
message	String	True	异常詳細信息
data	Object	False	成功與否 成功是1 ，錯誤返回0或null

響應樣例

{
    "code": 0,
    "message": "success",
    "data": 1
}

獲取賬戶基礎信息和資源配置信息

接口描述

管理員創建賬號時填寫一系列基礎信息和資源配置信息，此部分信息支持用戶獲取,此接口爲通過賬戶ID獲取賬戶基礎信息和資源配置及使用情况。。

請求地址

GET /api/2dvh/v1/user/config/resource?userId={userId}

請求頭

Content-Type: application/x-www-form-urlencode

請求參數

字段	類型	必填	描述
userId	Long	True	賬戶id

請求樣例

https://xxx.softsugar.com/api/2dvh/v1/user/config/resource?userId=2

響應元素

字段	類型	必填	描述
code	Integer	True	0 - 成功, 其他 - 异常
message	String	True	异常詳細信息
data	Object	False	數據對象 ，錯誤返回null
- basicInfo	Obejct	True	賬戶基礎信息
- resourceConfig	Obejct	True	賬戶資源配置及使用信息

基礎信息

字段	類型	必填	描述
id	Integer	True	id
company	String	True	企業名稱
effectiveBeginDate	Date	True	服務有效期開始時間, yyyy-MM-dd HH:mm:ss
effectiveEndDate	Date	True	服務有效期結束時間, yyyy-MM-dd HH:mm:ss
appId	String	True	APP id（用戶接入鑒權使用ID）
appKey	String	True	APP key

資源配置及使用量信息

字段	類型	必填	描述
id	Long	True	id
genCharModelTotalQty	Integer	True	可生成人物形象模型數總可用量
genCharModelUsageQty	Integer	True	可生成人物形象模型數總已用量
genTtsCharVoiceModelTotalQty	Integer	True	可生成TTS個人音色模型數總可用量
genTtsCharVoiceModelUsageQty	Integer	True	可生成TTS個人音色模型數總已用量
genVideoDurationTotalQty	Integer	True	可生成視頻時長總可用量
genVideoDurationUsageQty	Integer	True	可生成視頻時長總已用量
charModelMaxConTasksTotalQty	Integer	True	人物形象模型最大幷發任務數總可用量
charModelMaxConTasksUsageQty	Integer	True	人物形象模型最大幷發任務數總已用量
ttsCharVoiceModelMaxConTasksTotalQty	Integer	True	TTS個人音色模型生成最大幷發任務數總可用量
ttsCharVoiceModelMaxConTasksUsageQty	Integer	True	TTS個人音色模型生成最大幷發任務數總已用量
videoGenMaxConTasksTotalQty	Integer	True	視頻生成最大幷發任務數總可用量
videoGenMaxConTasksUsageQty	Integer	True	視頻生成最大幷發任務數總已用量

響應樣例

{
    "code": 0,
    "message": "success",
    "data": {
		"resourceConfig": {
            "id": 1,
            "company": "zhangsan",
            "effectiveBeginDate": "2019-01-01 20:20:20",
            "effectiveEndDate": "2019-01-01 20:20:20",
            "appId": "7sadf7sadf7ads7f7asf7sda7f",
            "appKey": "7sadf7sadf7ads7f7asf7sda7f"
        },
        "resourceConfig": {
            "id": 1,
            "genCharModelTotalQty": 12,
            "genCharModelUsageQty": 2,
            "genTtsCharVoiceModelTotalQty": 12,
            "genTtsCharVoiceModelUsageQty": 2,
            "genVideoDurationTotalQty": 21,
            "genVideoDurationUsageQty": 11,
            "charModelMaxConTasksTotalQty": 12,
            "charModelMaxConTasksUsageQty": 3,
            "ttsCharVoiceModelMaxConTasksTotalQty": 11,
            "ttsCharVoiceModelMaxConTasksUsageQty": 4,
            "videoGenMaxConTasksTotalQty": 11,
            "videoGenMaxConTasksUsageQty": 7
        }
    }
}

以上即爲平臺針對用戶接入平臺使用服務時需要進行的準備工作。