Conventions
Adresse, format des données, identifiants, langues et en-têtes communs à toutes les routes.
Adresse et format
- Adresse :
https://api.corcelink.fr/v1. HTTPS uniquement. - Corps des requêtes et des réponses en JSON, encodé en UTF-8 (
Content-Type: application/json). - Noms de champs en
snake_case, dates au format ISO 8601 en UTC (2026-10-27T12:30:38Z). - Montants en centimes, avec leur devise :
{"amount": 790, "currency": "EUR"}vaut 7,90 €.
Organisation
L’API est rangée par familles de produits :
| Espace | Contenu |
|---|---|
/account |
Votre compte et la clé utilisée |
/services |
Inventaire de tous vos services, toutes familles |
/catalog |
Régions et catalogue |
/compute/vps |
Serveurs VPS, leurs adresses, leur pare-feu |
/network/private-networks |
Réseaux privés entre VPS, membres et routes statiques |
/billing |
Factures et devis, avec leurs PDF |
/support |
Départements et demandes d’assistance |
/operations |
Suivi des opérations longues |
Les prochaines familles prendront place à côté (voir Prochainement).
Identifiants
Les identifiants sont stables et préfixés par leur type. Ne cherchez pas à en déduire autre chose que ce type.
| Préfixe | Ressource |
|---|---|
vps- |
VPS |
fwr- |
Règle de pare-feu (l’identifiant suit la règle quand elle est déplacée ou modifiée par l’API) |
pn- |
Réseau privé |
rt- |
Route statique d’un réseau privé |
bkp- |
Sauvegarde |
inv- |
Facture (son numéro légal est dans number) |
qt- |
Devis |
svc- |
Service d’une famille qui n’a pas encore ses routes (dans l’inventaire) |
dom- |
Nom de domaine (dans l’inventaire) |
msg- |
Message d’une demande d’assistance (la demande garde son numéro, par exemple KQV-204118) |
op- |
Opération |
evt- |
Événement du journal |
key- |
Clé API |
req- |
Requête (X-Request-Id) |
Langue des messages
Les messages d’erreur et les libellés du journal sont en français par défaut, en anglais avec Accept-Language: en. La langue retenue est rappelée dans l’en-tête Content-Language. Les codes et les valeurs (running, missing_scope…) ne changent jamais avec la langue.
Valeurs extensibles
De nouvelles valeurs peuvent apparaître dans les listes de valeurs : un nouvel état de VPS, une nouvelle famille de produits, un nouveau type d’événement. Traitez une valeur inconnue sans erreur, par exemple comme « autre ».
En-têtes des réponses
| En-tête | Contenu |
|---|---|
X-Request-Id |
Identifiant de la requête, à citer au support |
RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset |
Votre quota (voir Limites et performances) |
ETag |
Version de la ressource (voir Concurrence) |
Location |
Adresse de la ressource créée ou de l’opération à suivre |
Idempotent-Replayed |
true quand la réponse est celle d’une requête déjà traitée (voir Idempotence) |
Server-Timing |
Temps de traitement de la requête |
CorceLink-Api-Version |
Version de l’API qui a répondu |