Documentation de l'API, de Terraform et du CLI
Référence de l'API, guides pour Terraform, la ligne de commande, le Go SDK et l'application mobile, et une introduction pour les nouveaux utilisateurs de l'API.
Commencer par l'API
L'API VPSie est ouverte à tous les clients. La référence est publiée et vous pouvez tester les appels en direct.
Démarrer avec l'API
Cinq étapes, de zéro à un appel fonctionnel.
- Créer un client API ou un jeton d'accès dans la console, sous Accès API
- Échanger l'ID client et le secret client contre un jeton à durée limitée, ou utiliser un jeton d'accès personnel
- Envoyer le jeton dans l'en-tête
vpsie-auth - Appeler
GET /datacenterpour vérifier que le nom, la route et le jeton fonctionnent - Consulter la référence pour chaque point de terminaison, champ et exemple
Adresse de base https://api.vpsie.com/apps/v2. Entrée et sortie en JSON. Pour une installation privée, utilisez votre propre hôte API ; le chemin après le hôte est identique.
Guides pour chaque public et outil
Un guide par public et par outil. Chacun indique son contenu et son public cible.
Guide de l'API utilisateur
Authentification, création et gestion de serveurs, protection, lecture de la facturation et gestion des erreurs, y compris la connexion d'outils ERP et CRM et des installations privées.
- Versions courte et complète
- Exemples en curl
Guide de l'API revendeur
Intégration des clients, attribution des plans et des tarifs, crédit de fonds, lecture de l'utilisation et extraction des données de facturation depuis votre portail.
- Versions courte et complète
- Limité à vos clients
Guide de l'application mobile
Chaque menu de l'application VPSie Cloud pour iOS et Android, et ce qu'il faut attendre lorsqu'une fonctionnalité n'est pas activée sur votre compte.
- Connexion par e-mail, QR avec Client ID ou biométrie
Guide Terraform
Le fournisseur VPSie pour Terraform et OpenTofu gère les serveurs, les réseaux, le stockage et Kubernetes en tant que code.
- Fournisseur vpsie/vpsie
- Importer les ressources existantes
Guide de la ligne de commande
vpsiecli gère les serveurs, les snapshots, les pare-feu et la facturation depuis votre shell, pour les scripts et la CI.
- 28 groupes de commandes, 204 commandes
- Jeton à partir d'une configuration YAML
Guide du SDK Go
govpsie est le client Go pour l'API : serveurs, stockage, réseau, DNS, Kubernetes, facturation et plus encore en tant que méthodes typées.
- Licence MPL-2.0
- Go 1.24
Outils open source
Fournisseur Terraform
Publié sur le Terraform Registry sous vpsie/vpsie. Compatible avec OpenTofu.
Go SDK
github.com/vpsie/govpsie, documenté sur pkg.go.dev.
API d'administration
L'API opérateur pour une plateforme VPSie que vous exploitez vous-même (clients, plans, infrastructure, facturation, licences, audit). Fournie avec une installation de cloud privé.
- Demandez le guide à votre contact VPSie
Quel outil pour quel usage
| Outil | Idéal pour | Non adapté pour |
|---|---|---|
| API REST | Tout langage, liens ERP et CRM, tâches ponctuelles | Maintenir un environnement entier en synchronisation avec le code |
| Terraform | Environnements reproductibles que vous validez avant application | Modifications ponctuelles rapides |
| Ligne de commande | Scripts shell, tâches CI, actions rapides | Services de longue durée (utilisez le SDK) |
| Go SDK | Services que vous développez et déployez en Go | Autres langages (utilisez l'API REST) |
| Application mobile | Vérifier les serveurs et la facturation en déplacement | Travail en masse |
Plus d'aide
Base de connaissances
Guides pratiques, tutoriels d’application en un clic et réponses aux questions fréquentes.
Questions sur la documentation VPSie
L’API est-elle disponible sur toutes les offres ?
Les rôles, le statut du compte et votre licence s’appliquent aux appels API exactement comme dans la console. Un appel à un service non inclus dans votre licence est refusé, même si le point de terminaison est documenté.
Puis-je exécuter un script sur une installation privée de VPSie ?
Oui. Utilisez votre propre nom d’hôte API au lieu de api.vpsie.com. Le chemin après l’hôte est le même, et l’appelant doit faire confiance au certificat présenté par l’installation.
Les champs vont-ils changer ?
Oui. La plateforme et son API évoluent avec le temps. Écrivez du code qui ignore les nouveaux champs et consultez apidocs.vpsie.com avant une mise à jour.
Où télécharger les guides ?
Les guides sont des documents PDF et Word partagés par VPSie. Demandez à votre gestionnaire de compte ou au support le jeu de documents actuel.
Base de connaissances par thème
Où chercher dans la base de connaissances pour chaque type de question.
| Si vous travaillez sur | Cherchez | Page associée |
|---|---|---|
| Serveurs et systèmes d'exploitation | Création, redimensionnement, reconstruction et accès aux serveurs cloud ; accès SSH et console | Calcul |
| Stockage et fichiers | Ajout de disques, montage de volumes, utilisation de buckets de stockage objet | Stockage, Buckets |
| Réseau et DNS | Réseaux privés, pare-feu, équilibrage de charge, adresses IP, enregistrements DNS | Réseau, DNS |
| Conteneurs | Clusters et charges de travail Kubernetes | Kubernetes |
| Sauvegarde et restauration | Snapshots, sauvegardes planifiées, restauration d'un serveur | Sauvegarde, Restauration |
| Applications en un clic | Installation et configuration d'applications prêtes à l'emploi | Applications |
| Sécurité et accès | Connexion à deux facteurs, clés, rôles utilisateurs, durcissement d'un serveur | Sécurité |
| Déménagement | Importation de machines depuis une autre plateforme | Migration |
Ordre de lecture pour les nouveaux utilisateurs
Un parcours dans la documentation qui évite les impasses.
Créer un compte
Inscrivez-vous sur my.vpsie.com, ajoutez un moyen de paiement et déployez un premier serveur.
Découvrir la console
Utilisez la base de connaissances pour les premières tâches de serveur, de stockage et de réseau.
Automatiser une tâche
Effectuez votre premier appel API depuis le démarrage rapide ci-dessus, puis choisissez la CLI ou Terraform pour les tâches récurrentes.
Protégez-le
Configurez les sauvegardes et un test de restauration avant l'arrivée des premières données réelles.
Construire sur VPSie
Créez un compte, générez un jeton et effectuez votre premier appel.