Primeiros passos com as API OVHcloud

Saiba como utilizar as API da OVHcloud

Esta tradução foi automaticamente gerada pelo nosso parceiro SYSTRAN. Em certos casos, poderão ocorrer formulações imprecisas, como por exemplo nomes de botões ou detalhes técnicos. Recomendamos que consulte a versão inglesa ou francesa do manual, caso tenha alguma dúvida. Se nos quiser ajudar a melhorar esta tradução, clique em "Contribuir" nesta página.

Última atualização: 30/05/2022

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

A responsabilidade sobre a configuração e a gestão dos serviços que a OVHcloud disponibiliza recai sobre o utilizador. Assim, deverá certificar-se de que estes funcionam corretamente.

Este manual fornece as instruções necessárias para realizar as operações mais habituais. No entanto, se encontrar dificuldades, recomendamos que recorra a um prestador de serviços especializado e/ou que contacte o editor do serviço. Não poderemos proporcionar-lhe assistência técnica. Para mais informações, aceda à secção «Quer saber mais?» deste guia.

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 Login no canto superior direito.
  • Introduza as suas credenciais OVHcloud.
  • Defina uma duração, sob a menção Validity, durante a qual autoriza as ações através das API OVHcloud.

API

Se a sua conta OVHcloud estiver protegida por uma dupla autenticação, deverá também introduzir o código gerado por SMS ou aplicação OTP ou chave U2F.

Explorar os produtos disponíveis nas API

Uma vez ligado, encontrará a lista dos produtos da OVHcloud que dispõem das API. Esta lista será classificada por ordem alfabética.

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.

API

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

API

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

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

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:

API keys

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.

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'])

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


Esta documentação foi-lhe útil?

Não hesite em propor-nos sugestões de melhoria para fazer evoluir este manual.

Imagens, conteúdo, estrutura... Não hesite em dizer-nos porquê para evoluirmos em conjunto!

Os seus pedidos de assistência não serão tratados através deste formulário. Para isso, utilize o formulário "Criar um ticket" .

Obrigado. A sua mensagem foi recebida com sucesso.

OVHcloud Community

Aceda ao seu espaço comunitário. Coloque as suas questões, procure informações e interaja com outros membros do OVHcloud Community.

Discuss with the OVHcloud community

Em conformidade com a alteração à Diretiva 2006/112/CE, os preços com IVA podem variar de acordo com o país de residência do cliente
(por defeito, os preços com IVA apresentados incluem o IVA português em vigor).