Ce qu'est l'API FreshPerf
L'API FreshPerf fait depuis vos scripts et vos serveurs ce que vous faites dans le tableau de bord : services, facturation, commandes, support.
| L'API | Détail |
|---|---|
| URL de base | https://api.freshperf.fr/v1 |
| Format | JSON en entrée et en sortie |
| Authentification | Authorization: Bearer fpk_..., une clé créée dans Compte > Clés d'API |
| Portée | votre compte uniquement |
| Référence complète | freshperf.fr/api-reference |
Une clé porte les permissions que vous cochez, se restreint à certains services et à certaines adresses IP, peut expirer, et se révoque avec effet à l'appel suivant. Le tableau de bord garde 30 jours de journal par clé.
Ce que vous pouvez faire
| Domaine | Opérations | Article |
|---|---|---|
| Services | lister, détail, état en direct, historique des ressources, démarrer / arrêter / redémarrer, console, sauvegardes, réinstallation, renommage, reprise et avance du renouvellement, options | Gérer vos services |
| Actions fournisseur | pare-feu et DNS inverse, par POST /services/{code}/actions/{action} | Gérer vos services |
| Facturation | factures et avoirs avec leurs PDF, solde prépayé et son historique, moyens de paiement enregistrés, paiement d'une facture | Factures, solde et paiements |
| Commandes | catalogue, passage d'une commande, paiement, suivi | Commander par l'API |
| Support et compte | tickets, clés SSH, notifications, accès délégués, profil | Tickets, clés SSH et compte |
Le pare-feu et le DNS inverse n'ont pas de route dédiée. Ils passent par la passerelle d'actions fournisseur, avec des arguments propres à chaque type d'infrastructure.
Ce qui reste dans le tableau de bord
- Arrêter un renouvellement.
PATCH /services/{code}avecautoRenew: falserépond400 RENEWAL_CANCELLATION_NOT_AVAILABLE_VIA_API. La reprise (autoRenew: true) passe, elle. - Gérer les clés d'API. Aucune route
/v1n'en crée, n'en liste ni n'en révoque. - Ajouter ou retirer un moyen de paiement. L'API lit la liste et débite ; elle ne l'alimente pas.
- La console interactive, l'envoi de fichiers, les sous-utilisateurs, les retraits de parrainage.
Où trouver quoi
| Ressource | Contenu |
|---|---|
| Cette rubrique | les clés, les permissions, les conventions, et chaque route avec ses champs et ses erreurs |
| /api-reference | la référence générée depuis le code, avec une console d'essai. En anglais |
https://api.freshperf.fr/v1/openapi.json | le même contenu pour les machines. Seule route de l'API qui ne demande pas de clé |
| status.freshperf.fr | l'état de la plateforme. Sa propre API, sans clé : voir API de la page de statut |
Ordre de lecture
- Démarrer en cinq minutes : créer une clé, faire un premier appel.
- Authentification, Permissions, Sécuriser vos clés : ce qu'une clé peut faire et comment la borner.
- Requêtes et réponses, Limites de débit et idempotence : les conventions communes à toutes les routes.
- Gérer vos services, Factures, solde et paiements, Commander par l'API, Tickets, clés SSH et compte : le contrat de chaque route.
- Référence des erreurs et Outils, OpenAPI et exemples de code au besoin.