SoftLayer API への認証

すなわち、ポータル/API ユーザー名を含む username と API アクセス・キーを含む apiKey です。認証ヘッダーを提供しない場合、API は exception「No valid authentication headers found」を戻します。無効な組み合わせの username と apiKey を提供すると、API は例外「Invalid API Token」を戻します。

SOAP による 認証 ヘッダーの表記は次のようになります。

<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 呼び出しによる方法の 2 とおりがあります。カスタマー・ポータルで独自の API アクセス・キーを生成するには、次のようにします。

  1. カスタマー・アカウントのマスター・ユーザーのユーザー名とポータル・パスワードを使用して、[https://manage.softlayer.com/ SoftLayer カスタマー・ポータル] にログインします。
  2. 管理 (administrative) をクリックしてから、API アクセス (API Access) リンクをクリックします。
  3. キーを生成したいユーザーを選択し、API アクセス・キーの生成 (Generate API Access Key) をクリックします。

API 呼び出しを使用して API アクセス・キーを生成するには、SoftLayer_User_Customer サービスで addApiAuthenticationKey メソッドを起動します。ユーザーの API アクセス・キーを削除するには、同じサービスで removeApiAuthenticationKey メソッドを実行します。API アクセス・キーを削除する際は注意してください。これらのキーを削除すると、そのユーザーは SoftLayer API を使用できなくなります。

一時的な API キー

SoftLayer_User_Customer::getPortalLoginToken でユーザー名/パスワードの組み合わせを使用することにより、存続時間が短い API キーを取得することが可能です。このトークンは、呼び出し中に API キーの代わりに使用でき、48 時間が過ぎると期限切れになります。

関連メソッド

関連項目

関連項目

  • [[SoftLayer_User_Customer_ApiAuthentication

外部リンク