# API調用
> `CNAPI`提供了一套通用的SDK接口規范,讓你用更為簡潔和現代化的方式調用接口服務。
每個API接口都會有一個接口調用地址(包括請求參數),因此可以通過傳統curl的方式來調用接口,如果需要調試接口推薦使用`postman`。
>[danger] 注意,目前接口數量正在擴充中,你可以發送郵件到`guanchaohui@aliyun.com`反饋你需要的API接口
# 接口參數
`CNAPI`接口的參數包括系統級參數和應用級參數,所有的應用參數都統一使用下劃線命名(字母小寫)規范。無論是付費接口還是免費接口,都必須傳入身份認證的系統傳參(參考下面)。
如果不是特殊說明,`CNAPI`的接口默認都支持GET/POST請求。
# 身份認證(app_code)
`CNAPI`所有的API調用服務必須設置app_code值,用于接口調用的身份認證。
>[danger] app_code的值可以在用戶中心“我的服務-->安全信息”的上方查詢到,每個用戶賬號擁有一個唯一的AppCode值(請不要隨意泄露)
目前支持使用兩種方式進行身份認證:
1. 通過Header信息認證
在請求Header中添加的Authorization字段,配置值為“app_code + 半角空格 +app_code值”。
格式如下:
Authorization:app_code app_code值
2. 通過請求參數認證
你需要在請求Query中添加app_code參數,參數的值為用戶app_code的值。
格式如下:
https://API接口地址?app_code=app_code值
>[info] 不一定是GET方式,POST參數一樣可以支持
# 返回數據
所有的接口返回數據為JSON格式,通用規范如下:
|名稱| 類型|說明|
|----|----|----|
|code|int|返回碼,0表示成功其它表示失敗|
|message|string|返回提示信息|
|data|object|返回數據|
>[info] 如果為付費接口,則當code為0的時候計費,其中data包含的數據請參考具體的接口說明。
# 接口預警
如果是付費接口,支持設置剩余調用次數預警。當到達設置的預警閾值的時候,會發送短信和郵件預警通知。注意及時續費,避免影響業務正常運行。
# 技術支持
如果在使用`CNAPI`的過程中有任何問題,或者需要反饋你需要的API接口可以發送郵件到`guanchaohui@aliyun.com`