Catalogue et géo

Droit : catalog:read.

GET /api/v1/products

Ce qui est en vente, avec le prix pour le titulaire de la clé. La liste ne contient que ce qui peut être acheté à l’instant ; un slug absent de la liste répond 400 unknown_product.

Champ	Signification
slug	transmis dans product lors du calcul et de l’achat : residential, ipv4
family	type de produit : traffic_gateway (trafic) ou dedicated (adresses fixes)
unit	unité de vente : gb ou ip
unit_price	prix du gigaoctet pour vous ; pour ipv4 - null, le prix dépend du pays et de la période
monthly_price_from	pour ipv4 : le prix le plus bas d’une adresse pour un mois, pour vous ; pour le trafic - null
min_volume, volume_presets, volume_discounts	volume d’achat de trafic : minimum, suggestions pour l’interface, paliers de volume en pourcentage

Le montant final est calculé par POST /api/v1/quote.

Paramètres du produit

GET /api/v1/products/{product}/options - ce que vous pouvez choisir à l’achat d’adresses fixes. Pour le produit de trafic, countries est vide : il s’achète uniquement au volume.

curl "https://ipv.rent/api/v1/products/ipv4/options" \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "type": "ipv4",
  "countries": [
    {
      "code": "us",
      "name": "United States",
      "periods": ["week", "2_weeks", "month", "2_months", "3_months"],
      "quantity_max": null,
      "plans": [
        {
          "id": "dc",
          "traffic_gb": null,
          "periods": ["week", "2_weeks", "month", "2_months", "3_months"],
          "operators": [
            {
              "id": "united-states",
              "name": "United States",
              "available": 374
            }
          ]
        }
      ]
    }
  ]
}

Champ	Où il va dans l’achat	Signification
countries[].code	country	pays, ISO 3166-1 alpha-2
countries[].periods	period	durées pour lesquelles le pays est vendu
countries[].quantity_max	quantity	combien d’adresses peuvent être prises en un seul achat ; null - pas de limite distincte
plans[].id	plan	tarif ; peut être omis s’il n’y a qu’un seul tarif dans le pays
plans[].operators[].id	operator	emplacement : le pays entier ou une ville ; obligatoire
plans[].operators[].available	-	combien d’adresses sont libres dans l’emplacement en ce moment

Relisez les paramètres avant chaque achat au lieu de les stocker chez vous : l’ensemble des pays et les stocks changent.

Erreurs : 400 unknown_product (slug inconnu ou produit non vendu).

Catalogue géo

Pour Residential uniquement : par où un forfait de trafic peut sortir. Quatre niveaux, et chacun d’eux :

• accepte un product obligatoire - aujourd’hui residential ;
• prend en charge If-None-Match et répond 304 sans corps ;
• renvoie version et ne distingue pas la casse des codes.

ETag - un hachage opaque de la version ; la même version sous forme lisible - le champ version.

Route	Paramètres	Réponse
GET /api/v1/geo/countries	product	countries[] avec code, name, pool (thin | normal | deep)
GET /api/v1/geo/states	product, country	states[] avec code et name
GET /api/v1/geo/cities	product, country, state (facult.)	cities[] avec code et name
GET /api/v1/geo/asns	product, country	asns[] avec code et name

curl "https://ipv.rent/api/v1/geo/countries?product=residential" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Sans state, cities renvoie toutes les villes du pays. Un pays qui n’est plus desservi donne une liste vide, pas une erreur.

Erreurs : 400 validation_failed (product ou country non transmis), unknown_product (slug inconnu ou produit non vendu) ; 503 catalog_unavailable.

Les codes de ces réponses sont ceux qu’accepte geo lors de la génération des connexions ; une valeur hors catalogue reçoit 422 invalid_targeting.