--- title: "Primeiros passos com as API OVHcloud" description: "Saiba como utilizar as API da OVHcloud" url: https://docs.ovhcloud.com/pt/guides/manage-and-operate/api/first-steps lang: pt lastUpdated: 2025-05-13 --- # Primeiros passos com as API OVHcloud :::info 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. ::: ## Objetivo As API disponíveis em [https://api.ovh.com/](https://eu.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](https://eu.api.ovh.com/). ## Instruções :::warning 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](https://partner.ovhcloud.com/pt/directory/) 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?](#gofurther)» deste guia. ::: ### Utilização simples #### Ligar-se às API OVHcloud Na página das [API OVHcloud](https://eu.api.ovh.com/) , 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. ![API](/images/manage-and-operate/api/first-steps/login.png) :::info Se a sua conta OVHcloud estiver protegida por uma [dupla autenticação](/pt/guides/account-and-service-management/account-information/secure-ovhcloud-account-with-2fa.md), deverá também introduzir o código gerado por SMS ou aplicação OTP ou chave U2F. ::: #### Explorar os produtos disponíveis nas API No menu à esquerda, encontrará uma lista dos produtos OVHcloud que podem ser geridos através das API. ![API](/images/manage-and-operate/api/first-steps/api-list.png) 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](/images/manage-and-operate/api/first-steps/api-displayed.png) 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](/pt/guides/manage-and-operate/api/apiv2.md). #### 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: 🇪🇺EU▾ [GET/domain](https://eu.api.ovh.com/console/?section=/domain&branch=v1#get-/domain) **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: 🇪🇺EU▾ [POST/domain/zone/{zoneName}/record](https://eu.api.ovh.com/console/?section=/domain&branch=v1#post-/domain/zone/-zoneName-/record) **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: 🇪🇺EU▾ [PUT/domain/zone/{zoneName}/record/{id}](https://eu.api.ovh.com/console/?section=/domain&branch=v1#put-/domain/zone/-zoneName-/record/-id-) **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: 🇪🇺EU▾ [DELETE/domain/zone/{zoneName}/record/{id}](https://eu.api.ovh.com/console/?section=/domain&branch=v1#delete-/domain/zone/-zoneName-/record/-id-) ##### 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: ![API](/images/manage-and-operate/api/first-steps/parameters.png) 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. ![API](/images/manage-and-operate/api/first-steps/result.png) 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/](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](/images/manage-and-operate/api/first-steps/api-keys.png) Depois de clicar em `Create keys `, irá obter três chaves: - a chave de aplicação, chamada **AK**. Por exemplo: ```console 7kbG7Bk7S9Nt7ZSV ``` - a sua chave de aplicação secreta, para não divulgar, chamada **AS**. Por exemplo: ```console EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF ``` - um "**consumer key**" secreto, a não divulgar, chamado **CK**. Por exemplo: ```console 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](/pt/guides/manage-and-operate/api/first-steps.md) (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: ```console "$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](https://github.com/ovh/perl-ovh) - _Python_ : [https://github.com/ovh/python-ovh](https://github.com/ovh/python-ovh) - _PHP_ : [https://github.com/ovh/php-ovh](https://github.com/ovh/php-ovh) - _Node.js_ : [https://github.com/ovh/node-ovh](https://github.com/ovh/node-ovh) - _Swift_ : [https://github.com/ovh/swift-ovh](https://github.com/ovh/swift-ovh) - _C#_ : [https://github.com/ovh/csharp-ovh](https://github.com/ovh/csharp-ovh) Eis um exemplo de utilização da secção `/me` que permite gerir a sua conta OVHcloud: ```python import ovh # Instantiate. Visit https://api.ovh.com/createToken/?GET=/me # to get your credentials client = ovh.Client( endpoint='ovh-eu', application_key='', application_secret='', 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](https://eu.api.ovh.com/) ou o Área de Cliente OVHcloud : **Através do Portal API OVHcloud** - Listar os IDs das chaves com a seguinte chamada: - Obtenha os detalhes de uma chave com a seguinte chamada: - Revogue uma chave com a seguinte chamada: 🇪🇺EU▾ [DELETE/me/api/application/{applicationId}](https://eu.api.ovh.com/console/?section=/me&branch=v1#delete-/me/api/application/-applicationId-) **Através da Área de Cliente OVHcloud** Aceda à página Chaves API. ![API keys manager](/images/manage-and-operate/api/first-steps/api-keys-manager.png) ## Saiba mais [](#) [Gerir um domínio através das API OVHcloud](/pt/guides/web-cloud/domains/api-domain-intro.md) (guia em inglês) [Como gerir a conta de um cliente OVHcloud através das API](/pt/guides/manage-and-operate/api/first-steps.md) (guia em inglês) Fale com a nossa [comunidade de utilizadores](https://community.ovhcloud.com/).