資源描述:
《阿里云API網(wǎng)關(guān)服務(wù)-API手冊(cè)-D》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。
1、API網(wǎng)關(guān)使用手冊(cè)(調(diào)用API)API網(wǎng)關(guān)/使用手冊(cè)(調(diào)用API)使用手冊(cè)(調(diào)用API)調(diào)用API您可以通過(guò)API網(wǎng)關(guān),調(diào)用由其他阿里云用戶或者第三方服務(wù)商開放的API服務(wù)。API網(wǎng)關(guān)將為您提供一系列管理服務(wù)與支撐。調(diào)用示例您可以基于API網(wǎng)關(guān)提供的SDK,通過(guò)編寫代碼的方式調(diào)用API。也可以自行編輯HTTP請(qǐng)求調(diào)用API。API的請(qǐng)求結(jié)構(gòu)如下://假如,域名:a13db7999e494a90819cce500130034d.com//假如,Path:/web/cloudapi/mapping/service//假如,Query內(nèi)容是:a=n
2、ame,b=12http://a13db7999e494a90819cce500130034d.com/web/cloudapi/mapping/service?a=name&b=12//則請(qǐng)求的url如下//請(qǐng)求的MethodPOSTHttpMethod:POST//Headers中需要包含簽名信息和部分參數(shù)X-Ca-Version:1//API版本X-Ca-Signature-Headers:X-Ca-Version,X-Ca-Key,X-Ca-Stage,X-Ca-Timestamp//參與簽名的HeaderX-Ca-Key:60028
3、305//AppKeyX-Ca-Stage:test//StageX-Ca-Timestamp:1456905123049//時(shí)間戳X-Ca-Signature:UAaH/qteir4G9UK4YR+NWdyq+c1rjl0PvtO/C1Qo68U=//簽名//詳細(xì)加密簽名的計(jì)算傳遞方式,請(qǐng)查看文檔--入口及協(xié)議。//Http標(biāo)準(zhǔn)頭//服務(wù)地址Host:a13db7999e494a90819cce500130034d.comDate:Wed02Mar201607:52:02GMT5API網(wǎng)關(guān)/使用手冊(cè)(調(diào)用API)User-Agent:Apa
4、che-HttpClient/4.1.2(java1.6)Content-Type:application/x-www-form-urlencoded;charset=utf-8Amount=11&InstanceId=ClientInstanceId&InstanceName=ClientInstanceName//Body內(nèi)容以上內(nèi)容加上API的入?yún)⒕蜆?gòu)成了API請(qǐng)求。其中,在公測(cè)階段,您需要在線下從提供API的服務(wù)方獲取API的說(shuō)明文檔,獲取服務(wù)地址、Path等詳細(xì)說(shuō)明。AppKey是您創(chuàng)建的APP的密鑰,用于做身份驗(yàn)證。APP是您調(diào)用
5、API需要?jiǎng)?chuàng)建的身份。詳情將在后續(xù)內(nèi)容中說(shuō)明。應(yīng)用(APP)您需要?jiǎng)?chuàng)建應(yīng)用(APP)作為您調(diào)用API的身份,每個(gè)APP有一對(duì)AppKey和AppSecret密鑰對(duì),用于您請(qǐng)求時(shí)做加密簽名,網(wǎng)關(guān)會(huì)對(duì)簽名做驗(yàn)證。1.在API網(wǎng)關(guān),您需要?jiǎng)?chuàng)建應(yīng)用(APP)作為請(qǐng)求者的身份。APP創(chuàng)建時(shí),系統(tǒng)會(huì)自動(dòng)分配一對(duì)AppKey和AppSecret,AppKey用于標(biāo)識(shí)您的身份,AppSecret是用于加密簽名字符串和服務(wù)器端驗(yàn)證簽名字符串的密鑰。調(diào)用API時(shí)您需要將AppKey和AppSecret加密簽名放入請(qǐng)求參數(shù),API網(wǎng)關(guān)會(huì)通過(guò)對(duì)稱加密來(lái)驗(yàn)證您的身份。
6、詳細(xì)加密簽名的計(jì)算傳遞方式,請(qǐng)查看文檔--入口及協(xié)議。2.AppKey和AppSecret密鑰對(duì),具備該APP的全部權(quán)限,需要妥善保管。如果發(fā)生泄漏,您可以在API網(wǎng)關(guān)的控制臺(tái)進(jìn)行重置。3.您可以擁有多個(gè)APP,可以根據(jù)您的業(yè)務(wù)需求分別被授權(quán)不同的API。注意,API的授權(quán)對(duì)象是APP而不是阿里云用戶賬號(hào)。4.您可以在API網(wǎng)關(guān)控制臺(tái)完成對(duì)APP的創(chuàng)建、修改、刪除、查看詳情、密鑰管理、查看已授權(quán)等管理操作。授權(quán)授權(quán),是指授予APP調(diào)用某個(gè)API的權(quán)限。您的APP需要獲得API的授權(quán)才能調(diào)用該API。在公測(cè)階段,由API服務(wù)方建立APP和API
7、之間的權(quán)限關(guān)系。1.在公測(cè)階段,由提供API的服務(wù)方來(lái)建立授權(quán)關(guān)系,您需要向其提供AppID或者您的阿里云郵箱賬戶,說(shuō)明給予某一個(gè)APP進(jìn)行授權(quán)。授權(quán)建立后,您就可以使用該APP調(diào)用API了。2.在公測(cè)階段,您不具備建立或者刪除授權(quán)的權(quán)限。您僅可以在控制臺(tái)查看相應(yīng)APP下已經(jīng)被授權(quán)的API。如果您需要解除某個(gè)API的授權(quán),請(qǐng)您聯(lián)系A(chǔ)PI服務(wù)提供方。加密簽名您調(diào)用API時(shí),需要使用AppKey和AppSecret計(jì)算加密簽名,完成身份驗(yàn)證。5API網(wǎng)關(guān)/使用手冊(cè)(調(diào)用API)1.在API網(wǎng)關(guān),使用APP作為您調(diào)用API的身份。APP創(chuàng)建時(shí),系統(tǒng)
8、會(huì)自動(dòng)分配AppKey和AppSecret。服務(wù)器端會(huì)通過(guò)驗(yàn)證AppKey和AppSecret來(lái)完成請(qǐng)求者的身份驗(yàn)證。2.無(wú)論使用HTTP還是HTTPS協(xié)議提交請(qǐng)求