管理即時 API 的認證
簡介
有幾種認證可與您的即時 API 工作搭配使用:
- 即時系統需要將剪輯片段推送到您選擇的目的地所需的 FTP、S3、視訊雲端或 Zencoder 憑證
- RTMP 憑證可防止某人取得您的即時蒸汽 RTMP 地址的人播放
- OAuth2 或即時系統需要將通知傳送通知給您的通知處理常式的基本授權憑證
即時 API 的認證端點允許建立和管理這些認證,然後您可以在建立即時或 VOD 剪輯工作時依其標籤參考這些認證。
有關憑證的API操作的完整詳細信息,請參見API參考。
認證類型
下表顯示目前支援的認證類型及其用途。
credential_type 值 |
說明/使用案例 |
---|---|
ftp |
應傳送剪輯片段的 FTP 站台認證 |
http |
要傳送通知給 http 位址的基本授權憑證 |
oauth |
要傳送通知的位址所需的 OAuth2 驗證憑證 |
rtmp |
將驗證新增至您的編碼器所連線的端點,以便擁有 RTMP URL 的任何人都不能只連線 |
s3 |
S3 儲存貯體可將剪輯片段傳送至 |
videocloud |
您的視訊雲端帳戶的 OAuth 認證可傳送剪輯片段 (必須包含動態擷取所需的權限) |
zencoder |
您的 ZenCoder 帳戶驗證將短片傳送至 |
認證作業
下表顯示管理認證的端點。
端點 | 方法 | 描述 |
---|---|---|
/v1/credentials |
GET |
列出帳戶的所有認證 |
/v1/credentials |
POST |
建立帳戶的新認證 |
/v1/credentials/{credential_id} |
PUT |
更新帳戶的認證 |
/v1/credentials/{credential_id} |
DELETE |
刪除帳戶的認證 |
證明資料欄位
下表顯示認證的欄位。
Field |
Type |
Required |
Allowed Values |
Default |
Description |
---|---|---|---|---|---|
|
boolean |
no |
|
false |
Want this credential to be default for the user for this type of credentials? |
|
string |
yes |
|
|
User identifiable name for the credentials |
|
enum |
yes |
|
|
The type of credential |
|
string |
yes |
|
|
The username, public key, or client id, depending on the credential type |
|
string |
yes |
|
|
The password, private key, or client secret, depending on the credential type |
|
string |
no |
|
(credentials are available for all account users) |
user_id (GUID) for which the credentials are being created |