API cho nhà phát triển

Bạn có thể mua và quản lý proxy ngay từ code của mình: đặt đơn hàng, đọc gói, gia hạn, theo dõi sự kiện. Mọi thứ bạn mua đều trở thành một gói. Có hai loại gói, phân biệt bằng trường family:

	Residential	IPv4
family	traffic_gateway	dedicated
Bạn mua gì	dung lượng lưu lượng tính bằng gigabyte	N địa chỉ riêng trong một thời hạn
Trả tiền cho gì	cho gigabyte, lưu lượng không hết hạn	cho mỗi địa chỉ theo kỳ: một tuần, 2 tuần, một tháng, 2 hoặc 3 tháng
Kết nối	tạo bao nhiêu chuỗi tùy ý với bất kỳ vị trí địa lý nào	danh sách địa chỉ cố định với một tên đăng nhập và mật khẩu
Đổi IP	xoay vòng hoặc liên kết đổi IP	thay toàn bộ địa chỉ của gói mỗi 30 ngày một lần
Sản phẩm	Residential	IPv4

Mua hàng, danh sách gói và thẻ gói là các route chung cho cả hai loại. Các thao tác chỉ có ở một loại được mô tả riêng: lưu lượng và địa chỉ cố định.

URL gốc và xác thực

https://ipv.rent

curl https://ipv.rent/api/v1/balance \
  -H 'Authorization: Bearer YOUR_API_KEY'

Đăng ký tại app.ipv.rent, sau đó xác nhận email: chưa xác nhận thì không đăng nhập được.

Khóa được tạo trong bảng điều khiển: Hồ sơ → Khóa API → Tạo khóa. Giá trị bí mật chỉ hiển thị một lần, mỗi tài khoản có tối đa 20 khóa đang hoạt động.

Khóa bị thu hồi sẽ lập tức không còn được chấp nhận, và sự kiện api_key.revoked được ghi vào nhật ký.

401 invalid_api_key - khóa không được chấp nhận. 403 insufficient_scope - khóa không có quyền mà route yêu cầu.

Lược đồ yêu cầu và phản hồi với mọi trường và ví dụ - trong tài liệu tham khảo OpenAPI.

Quyền của khóa

Khóa được tạo mà không chỉ định quyền sẽ nhận tất cả. Không thể thay đổi bộ quyền của khóa đã tạo.

Quyền	Mở ra gì
catalog:read	sản phẩm và tham số của chúng, danh mục địa lý, tính giá
packages:read	danh sách gói, thẻ gói, các lựa chọn gia hạn
packages:write	mua hàng và mọi thao tác với gói: nạp thêm, kết nối, mật khẩu, gia hạn, thay địa chỉ, dấu vân tay, tự động gia hạn
orders:read	đơn hàng
orders:write	dành sẵn - hiện chưa route nào yêu cầu
billing:read	số dư và giao dịch
events:read	nhật ký sự kiện

Route

Danh mục và mua hàng - cho cả hai loại:

Route	Quyền	Idempotency-Key
GET /api/v1/products	catalog:read	-
GET /api/v1/products/{product}/options	catalog:read	-
POST /api/v1/quote	catalog:read	không
POST /api/v1/packages	packages:write	bắt buộc
GET /api/v1/packages	packages:read	-
GET /api/v1/packages/{id}	packages:read	-
POST /api/v1/packages/{id}/password	packages:write	không

Chỉ Residential:

Route	Quyền	Idempotency-Key
GET /api/v1/geo/countries, /states, /cities, /asns	catalog:read	-
POST /api/v1/packages/{id}/proxies	packages:write	không
POST /api/v1/packages/{id}/topup	packages:write	bắt buộc
POST /api/v1/packages/{id}/rotation-secret	packages:write	không

Chỉ IPv4:

Route	Quyền	Idempotency-Key
GET /api/v1/packages/{id}/prolong-options	packages:read	-
POST /api/v1/packages/{id}/prolong	packages:write	bắt buộc
POST /api/v1/packages/{id}/replace	packages:write	không
POST /api/v1/packages/{id}/fingerprint	packages:write	không
POST /api/v1/packages/{id}/renewal	packages:write	không

Tài khoản:

Route	Quyền	Idempotency-Key
GET /api/v1/orders, /orders/{id}	orders:read	-
GET /api/v1/balance, /transactions	billing:read	-
GET /api/v1/events	events:read	-

Thao tác của loại khác trên một gói trả về 422 unsupported_capability.

Nạp tiền vào số dư và quản lý khóa - chỉ trong bảng điều khiển.

Giới hạn

120 yêu cầu mỗi phút cho mỗi khóa, cộng thêm 30 mỗi phút cho các yêu cầu làm thay đổi dữ liệu (POST). Mỗi phản hồi có RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset; vượt giới hạn - 429 với retry_after và Retry-After: chờ đúng số giây được chỉ định rồi thử lại.

Hỗ trợ

Telegram: @ipvrent_support, email [email protected]. Đính kèm request_id từ nội dung phản hồi lỗi.

Tin tức và trạng thái dịch vụ - trên kênh t.me/ipvrent.