API pour les développeurs
Vous pouvez acheter et gérer des proxys depuis votre propre code : passer des commandes, lire les
forfaits, prolonger, suivre les événements. Tout ce que vous achetez devient un forfait.
Il existe deux types de forfaits, distingués par le champ family :
| Residential | IPv4 | |
|---|---|---|
family | traffic_gateway | dedicated |
| Ce que vous achetez | un volume de trafic en gigaoctets | N adresses dédiées pour une durée |
| Comment vous payez | au gigaoctet, le trafic n’expire pas | à l’adresse par période : une semaine, 2 semaines, un mois, 2 ou 3 mois |
| Connexions | vous générez autant de lignes que vous voulez, avec n’importe quelle géo | liste fixe d’adresses avec un seul identifiant et mot de passe |
| Changement d’IP | rotation ou lien de changement d’IP | remplacement de toutes les adresses du forfait une fois tous les 30 jours |
| Produit | Residential | IPv4 |
L’achat, la liste des forfaits et la fiche d’un forfait sont des routes communes aux deux types. Les opérations propres à un seul type sont décrites séparément : trafic et adresses fixes.
Base et authentification
Section intitulée « Base et authentification »https://ipv.rentcurl https://ipv.rent/api/v1/balance \ -H 'Authorization: Bearer YOUR_API_KEY'Inscription - sur app.ipv.rent, puis confirmez votre e-mail : sans confirmation, la connexion reste fermée.
La clé est émise dans l’espace client : Profil → Clés API → Créer une clé. Le secret n’est affiché qu’une seule fois, jusqu’à 20 clés actives par compte.
Une clé révoquée cesse immédiatement d’être acceptée, et l’événement api_key.revoked est ajouté
au journal.
401 invalid_api_key - la clé n’est pas acceptée. 403 insufficient_scope - la clé n’a pas le
droit exigé par la route.
Les schémas des requêtes et des réponses avec tous les champs et des exemples - dans la référence OpenAPI.
Droits de la clé
Section intitulée « Droits de la clé »Une clé émise sans préciser de droits les reçoit tous. L’ensemble des droits d’une clé émise ne peut pas être modifié.
| Droit | Ce qu’il ouvre |
|---|---|
catalog:read | produits et leurs paramètres, catalogue géo, calcul du prix |
packages:read | liste des forfaits, fiche d’un forfait, options de prolongation |
packages:write | achat et toutes les opérations sur les forfaits : ajout de trafic, connexions, mot de passe, prolongation, remplacement des adresses, empreinte, renouvellement automatique |
orders:read | commandes |
orders:write | réservé - aucune route ne l’exige aujourd’hui |
billing:read | solde et transactions |
events:read | journal des événements |
Catalogue et achat - pour les deux types :
| Route | Droit | Idempotency-Key |
|---|---|---|
GET /api/v1/products | catalog:read | - |
GET /api/v1/products/{product}/options | catalog:read | - |
POST /api/v1/quote | catalog:read | non |
POST /api/v1/packages | packages:write | obligatoire |
GET /api/v1/packages | packages:read | - |
GET /api/v1/packages/{id} | packages:read | - |
POST /api/v1/packages/{id}/password | packages:write | non |
Residential uniquement :
| Route | Droit | Idempotency-Key |
|---|---|---|
GET /api/v1/geo/countries, /states, /cities, /asns | catalog:read | - |
POST /api/v1/packages/{id}/proxies | packages:write | non |
POST /api/v1/packages/{id}/topup | packages:write | obligatoire |
POST /api/v1/packages/{id}/rotation-secret | packages:write | non |
IPv4 uniquement :
| Route | Droit | Idempotency-Key |
|---|---|---|
GET /api/v1/packages/{id}/prolong-options | packages:read | - |
POST /api/v1/packages/{id}/prolong | packages:write | obligatoire |
POST /api/v1/packages/{id}/replace | packages:write | non |
POST /api/v1/packages/{id}/fingerprint | packages:write | non |
POST /api/v1/packages/{id}/renewal | packages:write | non |
Compte :
| Route | Droit | Idempotency-Key |
|---|---|---|
GET /api/v1/orders, /orders/{id} | orders:read | - |
GET /api/v1/balance, /transactions | billing:read | - |
GET /api/v1/events | events:read | - |
Une opération de l’autre type sur un forfait répond 422 unsupported_capability.
La recharge du solde et la gestion des clés se font uniquement dans l’espace client.
120 requêtes par minute par clé, plus 30 par minute pour les requêtes qui modifient quelque chose
(POST). Chaque réponse porte RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset ; en cas
de dépassement - 429 avec retry_after et Retry-After : attendez le nombre de secondes
indiqué et réessayez.
Assistance
Section intitulée « Assistance »Telegram : @ipvrent_support, e-mail
[email protected]. Joignez le request_id du corps de l’erreur.
Actualités et état du service - dans le canal t.me/ipvrent.