Primeiros passos com as API OVHcloud

Objetivo

As API disponíveis em https://api.ovh.com/ permitem-lhe adquirir, gerir, atualizar e configurar produtos OVHcloud sem utilizar uma interface gráfica como a Área de Cliente.

Saiba como utilizar as API da OVHcloud e como associá-las às suas aplicações

Requisitos

• Ter uma conta OVHcloud ativa e conhecer os seus identificadores.
• Estar na página web das API OVHcloud.

Instruções

Utilização simples

Ligar-se às API OVHcloud

Na página das API OVHcloud, clique em Explore the OVH API para apresentar a lista das API.

Para utilizar as API nos seus produtos, deve ligar-se a este site graças aos seus identificadores OVHcloud.

• Clique em Authentication no canto superior esquerdo.
• De seguida, clique em Login with OVHcloud SSO.
• Introduza as suas credenciais OVHcloud.
• Clique no botão Authorize para autorizar as chamadas às API a partir deste site.

Explorar os produtos disponíveis nas API

No menu à esquerda, encontrará uma lista dos produtos OVHcloud que podem ser geridos através das API.

Para apresentar, por exemplo, as API associadas aos nomes de domínio, clique em /domain na lista.

Depois de clicar no produto, a lista das API deste último é apresentada por baixo.

Dispõe igualmente de um seletor à esquerda da lista dos produtos que permite escolher entre os ramos /v1 e /v2 da API. Se não está familiarizado com o princípio dos ramos da API, pode consultar a seguinte documentação sobre a API v2.

Executar uma API

Existem 4 tipos de API disponíveis que utilizam os chamados métodos HTTP:

GET

O método GET tem como objetivo recuperar os dados de um recurso.

Por exemplo, para obter a lista dos seus nomes de domínio, utilize a seguinte API:

POST

O método POST é utilizado para enviar dados suplementares para o recurso.

Por exemplo, para adicionar um registo à sua zona DNS, utilize a seguinte API:

PUT

O método PUT serve para substituir os dados atuais do recurso pelos dados do pedido.

Por exemplo, se se enganou num registo da sua zona DNS, utilize a seguinte API:

LETE

O método DELETE é utilizado para eliminar o recurso chamado.

Por exemplo, se não deseja conservar o registo DNS que adicionou à sua zona DNS, utilize a seguinte API:

Parâmetros da API

Depois de clicar na API à sua escolha, a secção Request permite atribuir as variáveis relativas à sua aplicação.

Por exemplo, para adicionar um registo TXT à sua zona DNS, poderá escolher os seguintes parâmetros:

Depois de definir os parâmetros, pode lançar a API clicando em EXECUTE.

O separador Response apresentado dar-lhe-á o relatório de execução da API.

Os separadores PHP e Python contêm os elementos que devem ser adicionados no script em função da linguagem utilizada.

Utilização avançada: associar as API OVHcloud a uma aplicação

Criar as chaves da sua aplicação

Qualquer aplicação que pretenda comunicar com a API da OVHcloud deve ser declarada previamente.

Para isso, clique na seguinte ligação: https://eu.api.ovh.com/createToken/.

Indique o seu ID de cliente, a sua palavra-passe e o nome da sua aplicação. O nome será útil mais tarde se quiser autorizar outras pessoas a utilizá-lo.

Também pode adicionar uma descrição da aplicação, bem como um calendário.

O campo Rights permite-lhe limitar a utilização da aplicação a certas API.
Para autorizar todas as API da OVHcloud para um método HTTP, insira uma estrela * no campo, como no exemplo abaixo onde o método GET é autorizado para todas as API:

Depois de clicar em Create keys, irá obter três chaves:

• a chave de aplicação, chamada AK. Por exemplo:

7kbG7Bk7S9Nt7ZSV

• a sua chave de aplicação secreta, para não divulgar, chamada AS. Por exemplo:

EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF

• um "consumer key" secreto, a não divulgar, chamado CK. Por exemplo:

MtSwSrPpNjqfVSmJhLbPyr2i45lSwPU1

Neste caso, a chave CK está associada à sua conta.

O token CK pode ser utilizado para a delegação de direitos. Para saber mais, consulte o seguinte guia: Como gerir a conta de um cliente OVHcloud através das API (guia em inglês).

Primeira utilização da API

Depois de obter as três chaves (AK, AS, CK), pode assinar os pedidos de API. A assinatura é calculada do seguinte modo:

"$1$" + SHA1_HEX(AS+"+"+CK+"+"+METHOD+"+"+QUERY+"+"+BODY+"+"+TSTAMP)

Para simplificar o desenvolvimento das suas aplicações, a OVHcloud fornece-lhe wrappers API em várias linguagens. Utilizá-los-á para que não se preocupe com o cálculo da assinatura e se concentre no desenvolvimento da sua aplicação.

• Perl : https://github.com/ovh/perl-ovh
• Python : https://github.com/ovh/python-ovh
• PHP : https://github.com/ovh/php-ovh
• Node.js : https://github.com/ovh/node-ovh
• Swift : https://github.com/ovh/swift-ovh
• C# : https://github.com/ovh/csharp-ovh

Eis um exemplo de utilização da secção /me que permite gerir a sua conta OVHcloud:

import ovh

# Instantiate. Visit https://api.ovh.com/createToken/?GET=/me
# to get your credentials
client = ovh.Client(
    endpoint='ovh-eu',
    application_key='<application key>',
    application_secret='<application secret>',
    consumer_key='<consumer key>',
)

# Print nice welcome message
print("Welcome", client.get('/me')['firstname'])

Liste e revogue as suas chaves

Para listar e revogar as chaves, é possível utilizar o portal API ou o Área de Cliente OVHcloud:

Saiba mais

Gerir um domínio através das API OVHcloud (guia em inglês)

Como gerir a conta de um cliente OVHcloud através das API (guia em inglês)

Fale com a nossa comunidade de utilizadores: https://community.ovh.com/en/.