本產品(
云通信號碼認證服務/2017-05-25
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
融合認證(基于原子能力)
API | 標題 | API概述 |
---|---|---|
短信認證服務 | 短信認證服務 | |
SendSmsVerifyCode | 發送短信驗證碼 | 發送短信驗證碼。 |
CheckSmsVerifyCode | 核驗驗證碼 | 核驗短信驗證碼并返回核驗是否成功的結果。 |
融合認證(基于場景)
API | 標題 | API概述 |
---|---|---|
GetFusionAuthToken | 融合認證獲取鑒權token | 融合認證客戶端完成初始化操作后,由開發者服務器發起調用此接口,獲取鑒權Token。獲取到的鑒權Token用于傳入SDK進行鑒權。 |
VerifyWithFusionAuthToken | 融合認證獲取認證結果 | 融合認證客戶端發起認證時,由開發者服務器通過鑒權Token換取的認證Token向阿里云發起本次調用,獲取認證結果。 |
號碼認證
API | 標題 | API概述 |
---|---|---|
客戶端一鍵登錄和本機號碼校驗 | 客戶端一鍵登錄和本機號碼校驗 | |
VerifyMobile | 本機號碼校驗認證 | 調用本接口進行本機號碼校驗認證,認證完成后返回認證結果。 |
GetMobile | 一鍵登錄取號 | 本接口用于號碼認證服務端一鍵登錄取號,成功取得號碼后會將號碼返回。 |
H5一鍵登錄和本機號碼校驗 | H5一鍵登錄和本機號碼校驗 | |
GetAuthToken | 獲取 H5 認證授權 Token | 獲取授權Token用于H5本機號碼校驗的鑒權,返回結果包括AccessToken和JwtToken。 |
GetPhoneWithToken | 一鍵登錄取號(H5能力專用) | 本接口用于號碼認證服務端(H5能力專用)一鍵登錄取號,成功取得號碼后會將號碼返回。 |
VerifyPhoneWithToken | 本機號碼校驗(H5能力專用) | 調用本接口進行H5頁面本機號碼校驗認證,認證完成后返回認證結果。 |
短信認證
API | 標題 | API概述 |
---|---|---|
GetSmsAuthTokens | 獲取短信驗證碼授權Token | 調用GetSmsAuthTokens接口獲取短信驗證碼授權Token。 |
VerifySmsCode | 完成短信驗證碼校驗 | 調用VerifySmsCode接口完成短信驗證碼校驗,校驗完成后返回認證結果。 |
通信授權服務
API | 標題 | API概述 |
---|---|---|
GetAuthorizationUrl | 獲取授權鏈接 | 獲取支付寶授權鏈接。 |
認證方案管理
API | 標題 | API概述 |
---|---|---|
CreateSchemeConfig | 創建融合認證方案號 | 融合認證方案用于標識App下的認證場景,一般一個認證方案對應一個App包名、包簽名。調用本接口創建融合認證方案并獲取方案Code。 |
CreateVerifyScheme | 創建認證方案 | 認證方案用于標識App下的認證場景,一般一個認證方案對應一個App名稱、App包名、包簽名等信息(接入端不同對應所需參數也不同),調用本接口創建認證方案。 |
DeleteVerifyScheme | 刪除認證方案 | 如果您不再使用某個認證方案,需要刪除方案時,調用此接口或在號碼認證服務控制臺刪除認證方案。 |
DescribeVerifyScheme | 獲取認證方案密鑰 | 調用其他API接口時會用到認證方案密鑰等參數信息,本接口用于獲取認證方案密鑰信息。 |
用量及費用統計
API | 標題 | API概述 |
---|---|---|
QueryGateVerifyStatisticPublic | 查詢用量情況 | 調用此接口查看統計日期范圍內,某個認證方式的總調用量、調用成功量、調用失敗量、調用未知量,及每一天的用量統計。 |
QueryGateVerifyBillingPublic | 查詢費用情況 | 調用此接口查詢某種認證方式下的月份費用賬單。 |