Authentification auprès de l'API de SoftLayer

username qui représente votre nom d'utilisateur API / votre portail et apiKey, qui représente votre clé d'accès à l'API. Si vous ne spécifiez pas l'en-tête d'authentification, l'API renvoie l'exception "Aucun en-tête d'authentification valide n'a été trouvé". Si vous spécifiez une combinaison non valide pour le nom d'utilisateur et la clé API, l'API renvoie l'exception "Jeton API non valide".

Voici un exemple de représentation SOAP de l'en-tête d'authentification :

<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>

Et voici maintenant un exemple de représentation XML-RPC pour cet en-tête :

<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>

Génération de votre clé API

Une clé d'accès API peut être générée de deux façons : via le portail ou par appel API direct. Pour générer votre propre clé d'accès API dans le portail client :

  1. Connectez-vous au https://manage.softlayer.com/ portail client SoftLayer] avec le nom d'utilisateur principal de votre compte client et avec le mot de passe du portail.
  2. Cliquez sur le lien Administration puis sur les liens Accès API.
  3. Sélectionnez l'utilisateur pour lequel vous voulez générer une clé, puis cliquez sur Générer une clé d'accès API.

Pour générer une clé d'accès API en effectuant un appel API, exécutez la méthode addApiAuthenticationKey dans le service SoftLayer_User_Customer. Pour supprimer la clé d'accès API d'un utilisateur, exécutez la méthode removeApiAuthenticationKey dans le même service. Soyez prudent quand vous supprimez des clés d'accès API : dès lors que ces clés sont supprimées, l'utilisateur ne peut plus recourir à l'API SoftLayer.

Clé d'API temporaire

Vous pouvez obtenir une clé d'API de courte durée à l'aide d'une combinaison nom d'utilisateur/mot de passe associée à SoftLayer_User_Customer::getPortalLoginToken. Ce jeton peut être utilisé à la place d'une clé API lors des appels et arrive à expiration après 48 heures.

Méthodes associées

Voir aussi

Liens externes