Primeros pasos con las API de OVHcloud

Objetivo

Las API disponibles en https://ca.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.

Procedimiento

Uso sencillo

Conectarse a la API de OVHcloud

En la página de las API de OVHcloud, 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.

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.

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.

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.

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:

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:

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:

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:

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:

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.

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

Al hacer clic en Create keys, obtendrá tres llaves:

• la clave de aplicación, llamada AK. Por ejemplo:

7kbG7Bk7S9Nt7ZSV

• su clave secreta, a no divulgar, llamada AS. Por ejemplo:

EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF

• una clave "consumer key" secreta, a no divulgar, llamada CK. Por ejemplo:

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

"$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
• 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
• C# : https://github.com/ovh/csharp-ovh

Este es un ejemplo de uso de la sección /me, que permite gestionar su cuenta de OVHcloud:

import ovh

# Instantiate. Visit https://ca.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'])

Lista y revoca tus claves

Para consultar y revocar las claves, puede utilizar el portal API o el área de cliente de OVHcloud:

Más información

Gestionar los dominios a través de la API (documentación en inglés)

Cómo gestionar la cuenta de un cliente de OVHcloud a través de las API (guía en inglés)

Interactúe con nuestra comunidad de usuarios en https://community.ovh.com/en/.