阿里云API網(wǎng)關(guān)服務(wù)-快速入門(mén)-D

《阿里云API網(wǎng)關(guān)服務(wù)-快速入門(mén)-D》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。

1、API網(wǎng)關(guān)快速入門(mén)（開(kāi)放API）API網(wǎng)關(guān)/快速入門(mén)（開(kāi)放API）快速入門(mén)（開(kāi)放API）概述本文將快速引導(dǎo)您創(chuàng)建并開(kāi)放API。您需要依次完成以下步驟才能成功開(kāi)放API服務(wù)：創(chuàng)建API分組API分組是API的管理單元，先創(chuàng)建API分組，然后在分組下創(chuàng)建API。分組有Region屬性，API選定分組就選定了Region，不可更改。分組創(chuàng)建時(shí)，會(huì)綁定一個(gè)唯一的二級(jí)域名，您可以訪問(wèn)該二級(jí)域名調(diào)用該分組下測(cè)試中的API。若要開(kāi)放API服務(wù)，您需要為分組綁定獨(dú)立域名，獨(dú)立域名需要在阿里云系統(tǒng)備案并且CNAM

2、E到該分組的二級(jí)域名上，用戶訪問(wèn)獨(dú)立域名調(diào)用該分組下線上的API。如果您的API支持HTTPS協(xié)議，您還需要為該獨(dú)立域名上傳SSL證書(shū)。綁定域名和證書(shū)域名是綁定在API分組上面的，API網(wǎng)關(guān)通過(guò)域名來(lái)定位到一個(gè)唯一的API分組，再通過(guò)Path+HTTPMethod確定唯一的API。如果您需要開(kāi)放API則需要為分組綁定獨(dú)立域名。獨(dú)立域名需要滿足以下幾點(diǎn)：1.獨(dú)立域名在阿里云系統(tǒng)備案成功，請(qǐng)求才能到達(dá)您的后端服務(wù)。2.若域名是在其他系統(tǒng)備案，則需要接入阿里云備案系統(tǒng)才能使用。備案和接入流程。3API

3、網(wǎng)關(guān)/快速入門(mén)（開(kāi)放API）1.獨(dú)立域名要CNAME解析到該分組的二級(jí)域名上，后操作綁定。先解析，后綁定，否則綁定操作會(huì)報(bào)錯(cuò)。2.域名驗(yàn)證需要在一天內(nèi)完成，一天之內(nèi)未完成的綁定請(qǐng)求會(huì)被系統(tǒng)自動(dòng)回收。3.若您需要將其他分組的獨(dú)立域名變更到當(dāng)前分組，需要先變更解析，才能成功綁定。完成備案和CNAME解析就完成了域名綁定，若備案接入過(guò)程有疑問(wèn)可以查看--備案和接入流程。若該分組下的API支持HTTPS協(xié)議，您還需要為該獨(dú)立域名上次SSL證書(shū)。不支持文件上傳，需要填寫(xiě)證書(shū)名稱、內(nèi)容和私鑰。創(chuàng)建APIAP

4、I分組創(chuàng)建完成您就可以創(chuàng)建API了，創(chuàng)建API是定義API請(qǐng)求的過(guò)程。您需要在創(chuàng)建中依次定義以下內(nèi)容：1.API的基本信息：分組、名稱、類型、描述。分組一旦選定，Region就選定了，不可更改。2.API的后端服務(wù)信息：后端服務(wù)類型、服務(wù)地址、服務(wù)超時(shí)時(shí)間。服務(wù)地址中可以包含動(dòng)態(tài)參數(shù)，這些動(dòng)態(tài)參數(shù)會(huì)被帶到Path的設(shè)置中，服務(wù)地址中的參數(shù)只能從Path中接受。3.API請(qǐng)求格式：協(xié)議、方法、Path、參數(shù)（包括Headers、Query、Body、常量參數(shù)和系統(tǒng)參數(shù)）、參數(shù)映射、參數(shù)校驗(yàn)。注意所

5、有的參數(shù)名稱彼此不能重復(fù)，所有的后端參數(shù)名稱彼此不能重復(fù)。4.API返回結(jié)果：返回類型及示例，目前網(wǎng)關(guān)對(duì)于返回結(jié)果不做處理。至此完成API的創(chuàng)建，并且具備開(kāi)放的條件。更多詳細(xì)的說(shuō)明請(qǐng)看使用手冊(cè)（開(kāi)放API）。發(fā)布API您完成API創(chuàng)建后，可以將API發(fā)布到測(cè)試，您可以創(chuàng)建自己的APP，然后通過(guò)訪問(wèn)二級(jí)域名調(diào)用測(cè)試中的API。調(diào)用API的方法，請(qǐng)您查看使用手冊(cè)（調(diào)用API）。如果您成功綁定了獨(dú)立域名，那么可以將API發(fā)布到線上，您給客戶的APP授權(quán)后，您的客戶可以通過(guò)訪問(wèn)獨(dú)立域名調(diào)用您線上的API

6、。API網(wǎng)關(guān)支持您對(duì)測(cè)試/線上的API做版本管理，您可以發(fā)布API、下線API還可以切換版本，切換版本是實(shí)時(shí)生效。授權(quán)給應(yīng)用應(yīng)用（APP）代表請(qǐng)求者的身份。每個(gè)應(yīng)用匹配AppKey和AppSecret用于計(jì)算加密簽名，網(wǎng)關(guān)會(huì)完成請(qǐng)求者身份驗(yàn)證。當(dāng)您的客戶或者您自己測(cè)試調(diào)用API時(shí)，都需要?jiǎng)?chuàng)建APP作為請(qǐng)求者的身份。然后由您該APP授權(quán)。授權(quán)操作需要以下幾個(gè)步驟：3API網(wǎng)關(guān)/快速入門(mén)（開(kāi)放API）1.獲知待授權(quán)的APP的AppID或者APP所有者的阿里云郵箱賬號(hào)。2.在授權(quán)操作頁(yè)面，選擇一個(gè)或者

7、多個(gè)準(zhǔn)備開(kāi)放調(diào)用權(quán)限的API，選定測(cè)試/線上。3.選定API后，用AppID或者阿里云郵箱賬號(hào)搜索到APP。4.確認(rèn)授權(quán)。至此，您已經(jīng)完成API的創(chuàng)建與開(kāi)放，客戶可以調(diào)用您的API了。請(qǐng)求到達(dá)網(wǎng)關(guān)時(shí)，網(wǎng)關(guān)會(huì)完成對(duì)APP的身份驗(yàn)證和權(quán)限驗(yàn)證。您還可以為您的API設(shè)置安全防護(hù)，如設(shè)置流量控制策略限定訪問(wèn)流量。網(wǎng)關(guān)還支持后端服務(wù)加簽，您可以設(shè)定簽名密鑰，當(dāng)網(wǎng)關(guān)向您的后端拋請(qǐng)求時(shí)做身份驗(yàn)證。安全與管理接下來(lái)您可以配置安全防護(hù)。目前API網(wǎng)關(guān)為您提供后端簽名和流量控制策略兩種安全措施。簽名密鑰服務(wù)用于您后

8、端做身份驗(yàn)證。您為API綁定了簽名密鑰之后，由網(wǎng)關(guān)拋向您后端的請(qǐng)求將攜帶簽名信息，您可以在后端通過(guò)對(duì)稱加密對(duì)請(qǐng)求進(jìn)行簽名驗(yàn)證。具體HTTP加簽說(shuō)明請(qǐng)查看文檔--后端HTTP服務(wù)簽名流量控制策略服務(wù)用于管制您API服務(wù)的流量。您為API綁定了流量控制策略之后，網(wǎng)關(guān)將協(xié)助您對(duì)API、用戶、應(yīng)用設(shè)置按分鐘、小時(shí)、天的調(diào)用量控制。您還可以在控制臺(tái)進(jìn)行更多API生命周期的管理操作，如API下線、API版本切換、API調(diào)用情況監(jiān)控和預(yù)警等。更多詳情請(qǐng)您查看使用手冊(cè)（開(kāi)放API）。3