Autenticando na API SoftLayer

username que contém o nome do usuário do portal/API, e apiKey que contém a chave de acesso da API. Se você não fornecer o cabeçalho autenticado, a API apresenta o exception "Nenhum cabeçalho de autenticação válido localizado." e, se você fornecer uma combinação de nome do usuário e apiKey inválida, a API apresenta o alerta "Token da API inválido".

Uma declaração SOAP do cabeçalho autenticado tem a aparência a seguir:

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

enquanto sua contraparte XML-RPC tem a aparência a seguir:

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

Gerando a chave da API

Há duas maneiras de gerar uma chave de acesso da API, por meio do portal ou por chamadas de API diretas. Para gerar sua própria chave de acesso da API no portal do cliente:

  1. Efetue login no [https://manage.softlayer.com/ SoftLayer customer portal] com o nome do usuário principal da conta de cliente e a senha do portal.
  2. Clique nos links administrativo, em seguida, Acesso da API.
  3. Selecione o usuário para o qual deseja gerar uma chave e clique em Gerar chave de acesso da API

Para gerar uma chave de acesso da API por meio de chamadas de API, chame o método addApiAuthenticationKey no serviço SoftLayer_User_Customer. Para remover a chave de acesso da API de um usuário, execute o método removeApiAuthenticationKey no mesmo serviço. Tome cuidado ao remover chaves de acesso da API. A remoção dessas chaves irá remover a capacidade desse usuário de usar a API da SoftLayer.

Chave Temporária da API

É possível obter uma chave da API por um curto período usando uma combinação de nome do usuário/senha com SoftLayer_User_Customer::getPortalLoginToken. Este token pode ser usado no lugar de uma chave da API durante chamadas e expirará após 48 horas.

Métodos associados

Consulte também

Links externos