L’interface publique pour les développeurs
Comprendre les API Scaleway
Compatibilité complète de l'écosystème
L’API de Scaleway est un élément clé de l’écosystème Scaleway : tout ce que vous pouvez faire depuis la console web peut être fait via des appels API. Par conséquent, les API vous donnent accès à tous les produits, y compris le stockage, le calcul et bien plus encore.
Accès aux API Cloud
Les API Scaleway sont accessibles via des requêtes HTTP traditionnelles ou via des bibliothèques clientes.
Nous utilisons des codes de réponse HTTP standards pour indiquer le succès ou l’échec d’une requête API.
Authentification
Chaque requête adressée aux API Scaleway doit être authentifiée. Les API Scaleway gèrent cela avec un en-tête HTTP X-Auth-Token qui doit être fourni avec la requête.
Endpoints
Toute API Scaleway est accessible via des points de terminaison (endpoint) : api.scaleway.com. Chaque point de terminaison suit ce modèle :
api.scaleway.com/{produit}/{version}/...
Retrouvez quelques examples ci-dessous.
Cas d’usage populaires
En intégrant les API Scaleway dans une interface de revente de produits cloud, vous ouvrez alors de nouvelles opportunités commerciales. Revendez simplement des instances virtuelles, du stockage ou tout autre produit cloud via votre propre plateforme étiquetée en marque blanche.
Pilotez l’intégralité de votre infrastructure directement à partir de votre système d’information ou de vos propres interfaces DevOps. Lorsque vous provisionnez des ressources à l’aide des différentes API des fournisseurs de cloud, il est plus facile de développer une stratégie multi-cloud.
Certains cas d’utilisation nécessitent de passer du temps à écrire des scripts avancés qui appelleront l’API publique. Ces scripts pourront ensuite créer ou supprimer automatiquement des instances, ajouter ou supprimer du stockage ou rediriger le trafic vers la bonne application. Et tout cela en fonction de données personnalisées (utilisation de la RAM, CPU, nombre d’utilisateurs ou encore des données météorologiques).
Foire aux questions
Qu'est-ce que l'API Scaleway ?
L’API Scaleway est l’interface publique Scaleway pour piloter vos ressources cloud sans utiliser la console Scaleway. API est l’acronyme de Application Programming Interface. Vous pouvez obtenir des informations sur votre infrastructure, créer des instances, effectuer des sauvegardes et bien plus encore avec quelques requêtes HTTP(S).
Comment autoriser l'accès à l'API ?
Pour utiliser l’API, vous devez au moins récupérer votre SECRET_KEY (ou TOKEN). Vous pouvez utiliser la console pour récupérer ces informations d’identification de l’API. Naviguez simplement sous l’onglet “credentials” dans le tableau de bord de votre projet et générez une nouvelle clé d’API.
Quelle est la différence entre la CLI et l'API ?
L’interface de ligne de commande (CLI) est un logiciel que vous utilisez sur un terminal qui est supposé être plus intuitif. Ce qui se cache derrière l’interface de ligne de commande est une requête API (voir le schéma technique ci-dessus).
Avec l’interface de ligne de commande, vous utiliseriez la commande suivante :
scw instance server list
Alors que l’appel API correspondant ressemble à ceci :
curl -H "X-Auth-Token: $TOKEN" https://api.scaleway.com/instance/v1/zones/fr-par-1/servers
Y a-t-il des fonctionnalités non disponibles dans la console qui le sont par API ?
Oui. Toutes les nouvelles fonctionnalités sont d’abord intégrées pour être compatibles avec l’API publique, puis disponibles dans la console. Cela signifie que vous pouvez également avoir accès à des fonctionnalités qui ne sont pas encore disponibles dans la console mais qui sont déjà intégrées à l’API publique.
Comment puis-je parler avec l'équipe API ?
N’hésitez pas à rejoindre la communauté Scaleway Community Slack. Nous sommes disponibles sur les channels #cli et #opensource.