Danh mục và địa lý
Quyền: catalog:read.
GET /api/v1/products
Phần tiêu đề “GET /api/v1/products”Những gì đang được bán, với giá dành cho chủ sở hữu khóa. Danh sách chỉ gồm những gì có thể mua
ngay bây giờ; slug ngoài danh sách trả về 400 unknown_product.
| Trường | Ý nghĩa |
|---|---|
slug | truyền vào product khi tính giá và mua: residential, ipv4 |
family | loại sản phẩm: traffic_gateway (lưu lượng) hoặc dedicated (địa chỉ cố định) |
unit | đơn vị bán: gb hoặc ip |
unit_price | giá mỗi gigabyte dành cho bạn; với ipv4 - null, giá phụ thuộc vào quốc gia và kỳ hạn |
monthly_price_from | với ipv4: giá thấp nhất của một địa chỉ cho một tháng dành cho bạn; với lưu lượng - null |
min_volume, volume_presets, volume_discounts | dung lượng khi mua lưu lượng: mức tối thiểu, gợi ý cho giao diện, bậc chiết khấu theo dung lượng tính bằng phần trăm |
Tổng số tiền được tính bởi POST /api/v1/quote.
Tham số sản phẩm
Phần tiêu đề “Tham số sản phẩm”GET /api/v1/products/{product}/options - những gì có thể chọn khi mua địa chỉ cố định.
Với sản phẩm lưu lượng, countries rỗng: sản phẩm này chỉ được mua theo dung lượng.
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 } ] } ] } ]}| Trường | Đi vào đâu khi mua | Ý nghĩa |
|---|---|---|
countries[].code | country | quốc gia, ISO 3166-1 alpha-2 |
countries[].periods | period | các thời hạn mà quốc gia được bán |
countries[].quantity_max | quantity | số địa chỉ có thể lấy trong một lần mua; null - không có giới hạn riêng |
plans[].id | plan | gói cước; có thể không truyền nếu quốc gia chỉ có một gói cước |
plans[].operators[].id | operator | vị trí: toàn quốc gia hoặc một thành phố; bắt buộc |
plans[].operators[].available | - | số địa chỉ hiện còn trống ở vị trí đó |
Hãy đọc lại tham số trước khi mua thay vì lưu lại: danh sách quốc gia và số lượng còn lại có thay đổi.
Lỗi: 400 unknown_product (slug không xác định hoặc sản phẩm không được bán).
Danh mục địa lý
Phần tiêu đề “Danh mục địa lý”Chỉ dành cho Residential: gói lưu lượng có thể đi ra từ đâu. Có bốn cấp, và mỗi cấp:
- nhận tham số bắt buộc
product- hiện tại làresidential; - hỗ trợ
If-None-Matchvà trả về 304 không có nội dung; - trả về
versionvà không phân biệt chữ hoa chữ thường của mã.
ETag - mã băm phiên bản không minh bạch; cùng phiên bản đó ở dạng dễ đọc - trường version.
| Route | Tham số | Phản hồi |
|---|---|---|
GET /api/v1/geo/countries | product | countries[] với code, name, pool (thin | normal | deep) |
GET /api/v1/geo/states | product, country | states[] với code và name |
GET /api/v1/geo/cities | product, country, state (tùy chọn) | cities[] với code và name |
GET /api/v1/geo/asns | product, country | asns[] với code và name |
curl "https://ipv.rent/api/v1/geo/countries?product=residential" \ -H 'Authorization: Bearer YOUR_API_KEY'Không có state, cities trả về mọi thành phố của quốc gia. Quốc gia không còn được phục vụ trả
về danh sách rỗng, không phải lỗi.
Lỗi: 400 validation_failed (thiếu product hoặc country), unknown_product (slug không xác
định hoặc sản phẩm không được bán); 503 catalog_unavailable.
Mã từ các phản hồi này là những gì geo chấp nhận khi
tạo kết nối; giá trị ngoài danh mục nhận 422
invalid_targeting.