--- title: "Primeros pasos con las API de OVHcloud" description: "Cómo utilizar las API de OVHcloud" url: https://docs.ovhcloud.com/es/guides/manage-and-operate/api/first-steps lang: es lastUpdated: 2025-05-13 --- # Primeros pasos con las API de OVHcloud :::info Esta traducción ha sido generada de forma automática por nuestro partner SYSTRAN. En algunos casos puede contener términos imprecisos, como en las etiquetas de los botones o los detalles técnicos. En caso de duda, le recomendamos que consulte la versión inglesa o francesa de la guía. Si quiere ayudarnos a mejorar esta traducción, por favor, utilice el botón "Contribuir" de esta página. ::: ## Objetivo Las API disponibles en [https://api.ovh.com/](https://eu.api.ovh.com/) le permiten adquirir, gestionar, actualizar y configurar productos de OVHcloud sin utilizar una interfaz gráfica como el área de cliente. **Cómo utilizar las API de OVHcloud y cómo asociarlas a sus aplicaciones** ## Requisitos - Disponer de una cuenta de OVHcloud activa y conocer sus claves de acceso. - Estar en la página web de las [API de OVHcloud](https://eu.api.ovh.com/). ## Procedimiento :::warning La configuración, la gestión y la responsabilidad de los servicios que OVHcloud pone a su disposición recaen sobre usted. Por lo tanto, usted deberá asegurarse de que estos funcionen correctamente. Esta guía le ayudará a realizar las operaciones más habituales. No obstante, si tiene alguna duda le recomendamos que contacte con un proveedor de servicios especializado o con el editor del servicio. Nosotros no podremos asistirle. Para más información, consulte el apartado [«Más información»](#gofurther) de esta guía. ::: ### Uso sencillo #### Conectarse a la API de OVHcloud En la página de las [API de OVHcloud](https://eu.api.ovh.com/) , haga clic en `Explore the OVH API ` para ver la lista de API. Para utilizar las API en sus productos, debe conectarse a este sitio web con sus claves de OVHcloud. - Haga clic en Authentication en la parte superior izquierda. - A continuación, haga clic en Login with OVHcloud SSO. - Introduzca sus claves de acceso OVHcloud. - Haga clic en el botón Authorize para autorizar las llamadas a las API desde este sitio web. ![API](/images/manage-and-operate/api/first-steps/login.png) :::info Si su cuenta de OVHcloud está protegida por una [doble autenticación](/es/guides/account-and-service-management/account-information/secure-ovhcloud-account-with-2fa.md), también deberá introducir el código generado por SMS o aplicación OTP o llave U2F. ::: #### Explorar los productos disponibles en las API En el menú de la izquierda, encontrará la lista de productos de OVHcloud que pueden gestionarse a través de las API. Esta lista se ordena por orden alfabético. ![API](/images/manage-and-operate/api/first-steps/api-list.png) Para ver, por ejemplo, las API asociadas a los dominios, haga clic en **/domain** en la lista. Haga clic en el producto para ver la lista de las API del mismo. ![API](/images/manage-and-operate/api/first-steps/api-displayed.png) También dispone de un selector a la izquierda de la lista de productos que le permite elegir entre las ramas **/v1** y **/v2** de la API. Si no está familiarizado con el principio de las ramas de la API, puede consultar [la siguiente documentación sobre la API v2](/es/guides/manage-and-operate/api/apiv2.md). #### Ejecutar una API Existen 4 tipos de API disponibles que utilizan los denominados métodos HTTP: **GET** El objetivo de la solución GET es recuperar los datos de un recurso. Por ejemplo, para consultar la lista de dominios, utilice la siguiente API: 🇪🇺EU▾ [GET/domain](https://eu.api.ovh.com/console/?section=/domain&branch=v1#get-/domain) **POST** El método POST se utiliza para enviar datos adicionales al recurso. Por ejemplo, para añadir un registro a su zona DNS, utilice la siguiente API: 🇪🇺EU▾ [POST/domain/zone/{zoneName}/record](https://eu.api.ovh.com/console/?section=/domain&branch=v1#post-/domain/zone/-zoneName-/record) **PUT** El método PUT se utiliza para sustituir los datos actuales del recurso por los datos de la consulta. Por ejemplo, si se ha equivocado al guardar la zona DNS, utilice la siguiente API: 🇪🇺EU▾ [PUT/domain/zone/{zoneName}/record/{id}](https://eu.api.ovh.com/console/?section=/domain&branch=v1#put-/domain/zone/-zoneName-/record/-id-) **DELETE** El método DELETE se utiliza para eliminar el recurso llamado. Por ejemplo, si no desea conservar el registro DNS que ha añadido a su zona DNS, utilice la siguiente 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 de la API Haga clic en la API que desee y seleccione **Request** para asignar las variables relativas a su aplicación. Por ejemplo, para añadir un registro TXT a su zona DNS, podrá elegir los siguientes parámetros: ![API](/images/manage-and-operate/api/first-steps/parameters.png) Una vez configurados los parámetros, puede ejecutar la API haciendo clic en `EXECUTE `. La pestaña `Response` mostrará el informe de ejecución de la API. ![API](/images/manage-and-operate/api/first-steps/result.png) Las pestañas `PHP` y `Python` contienen los elementos que se añadirán al script en función del idioma utilizado. ### Uso avanzado: combinar las API de OVHcloud con una aplicación #### Crear las claves de su aplicación Todas las aplicaciones que quieran comunicarse con la API de OVHcloud deben notificarse con antelación. Para ello, haga clic en el siguiente enlace: [https://eu.api.ovh.com/createToken/](https://eu.api.ovh.com/createToken/). Introduzca su identificador de cliente, su contraseña y el nombre de su aplicación. El nombre será útil más adelante si desea permitir que otras personas lo usen. También puede añadir una descripción de la aplicación y una temporalidad. El campo `Rights` le permite restringir el uso de la aplicación a determinadas API. Para autorizar todas las API de OVHcloud para un método HTTP, introduzca una estrella `*` en el campo, como en el siguiente ejemplo, en el que está autorizado el método GET para todas las API: ![API keys](/images/manage-and-operate/api/first-steps/api-keys.png) Al hacer clic en `Create keys `, obtendrá tres llaves: - la clave de aplicación, llamada **AK**. Por ejemplo: ```console 7kbG7Bk7S9Nt7ZSV ``` - su clave secreta, a no divulgar, llamada **AS**. Por ejemplo: ```console EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF ``` - una clave "**consumer key**" secreta, a no divulgar, llamada **CK**. Por ejemplo: ```console MtSwSrPpNjqfVSmJhLbPyr2i45lSwPU1 ``` En este caso, la clave **CK** está asociada a su cuenta. El token **CK** puede utilizarse para delegar permisos. Para más información, consulte la siguiente guía: [Cómo gestionar la cuenta de un cliente de OVHcloud a través de las API](/es/guides/manage-and-operate/api/first-steps.md) (guía en inglés). #### Uso inicial de la API Una vez que haya obtenido las tres claves (**AK**, **AS**, **CK**), puede firmar las solicitudes de API. La firma se calcula de la siguiente manera: ```console "$1$" + SHA1_HEX(AS+"+"+CK+"+"+METHOD+"+"+QUERY+"+"+BODY+"+"+TSTAMP) ``` Para simplificar el desarrollo de sus aplicaciones, OVHcloud le proporciona wrappers API en varios lenguajes. Utilizarlas le permitirá no preocuparse por el cálculo de la firma y centrarse en el desarrollo de su aplicación. - _Go_ : [https://github.com/ovh/go-ovh](https://github.com/ovh/go-ovh) - _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) - _C#_ : [https://github.com/ovh/csharp-ovh](https://github.com/ovh/csharp-ovh) Este es un ejemplo de uso de la sección `/me`, que permite gestionar su cuenta de 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']) ``` #### Lista y revoca tus claves Para consultar y revocar las claves, puede utilizar el [portal API](https://eu.api.ovh.com/) o el área de cliente de OVHcloud : **A través del Portal API OVHcloud** - Enumere los ID de las claves con la siguiente llamada: - Obtenga los detalles de una clave con la siguiente llamada: - Revoque una clave con la siguiente llamada: 🇪🇺EU▾ [DELETE/me/api/application/{applicationId}](https://eu.api.ovh.com/console/?section=/me&branch=v1#delete-/me/api/application/-applicationId-) **Desde el área de cliente de OVHcloud** Acceda a la página Claves API. ![API keys manager](/images/manage-and-operate/api/first-steps/api-keys-manager.png) ## Más información [](#) [Gestionar los dominios a través de la API](/es/guides/web-cloud/domains/api-domain-intro.md) (documentación en inglés) [Cómo gestionar la cuenta de un cliente de OVHcloud a través de las API](/es/guides/manage-and-operate/api/first-steps.md) (guía en inglés) Interactúe con [nuestra comunidad de usuarios](https://community.ovhcloud.com/).