對 SoftLayer API 進行鑑別

username 包含入口網站/API 使用者名稱,apiKey 包含 API 存取金鑰。如果您未提供鑑別標頭,API 會傳回 異常狀況「找不到有效的鑑別標頭。」,如果您提供無效的 username 和 apiKey 組合,則 API 會傳回異常狀況「API 記號無效」。

以 SOAP 呈現的 authenticate 標頭類似這樣:

<authenticate xsi:type="slt:authenticate" xmlns:slt="http://api.service.softlayer.com/soap/v3/SLTypes/">
    <username xsi:type="xsd:string">MY_USERNAME</username>
    <apiKey xsi:type="xsd:string">MY_API_ACCESS_KEY</apiKey>
</authenticate>

而其 XML-RPC 對應項目類似這樣:

<struct>
    <member>
        <name>authenticate</name>
        <value>
            <struct>
                <member>
                    <name>username</name>
                    <value>
                        <string>MY_USERNAME</string>
                    </value>
                </member>
                <member>
                    <name>apiKey</name>
                    <value>
                        <string>MY_API_ACCESS_KEY</string>
                    </value>
                </member>
            </struct>
        </value>
    </member>
</struct>

產生 API 金鑰

有兩種方式可產生 API 存取金鑰:透過入口網站或透過直接 API 呼叫。若要在客戶入口網站中產生您自己的 API 存取金鑰,請執行下列動作:

  1. 使用客戶帳號主要使用者的使用者名稱和入口網站密碼登入 [https://manage.softlayer.com/SoftLayer 客戶入口網站]。
  2. 按一下「管理」,再按一下「API 存取權」鏈結。
  3. 選取您要為其產生金鑰的使用者,並按一下「產生 API 存取金鑰」。

若要透過 API 呼叫產生 API 存取金鑰,請在 addApiAuthenticationKey 服務中呼叫 SoftLayer_User_Customer 方法。若要移除使用者的 API 存取金鑰,請在相同的服務中執行 removeApiAuthenticationKey 方法。移除 API 存取金鑰時請小心。移除這些金鑰也會移除該使用者使用 SoftLayer API 的能力。

Temporary API 金鑰

可以使用透過 SoftLayer_User_Customer::getPortalLoginToken 的使用者名稱/密碼組合,取得暫時的 API 金鑰。此記號可以在呼叫期間代替 API 金鑰,且記號將於 48 小時之後到期。

相關聯方法

另請參閱

另請參閱

  • [[SoftLayer_User_Customer_ApiAuthentication

外部鏈結