開発者向け API
プロキシの購入と管理は自分のコードから行えます。注文の作成、パッケージの取得、延長、
イベントの監視ができます。購入したものはすべてパッケージになります。
パッケージには 2 種類あり、family フィールドで区別します:
| Residential | IPv4 | |
|---|---|---|
family | traffic_gateway | dedicated |
| 購入するもの | ギガバイト単位のトラフィック容量 | 期間付きの N 個の専用アドレス |
| 支払い方 | ギガバイト単位、トラフィックは失効しない | アドレスごとの期間制: 1 週間、2 週間、1 か月、2 か月または 3 か月 |
| 接続 | 任意の地域で好きなだけ接続文字列を生成 | 1 組のログインとパスワードで使う固定のアドレス一覧 |
| IP の変更 | ローテーションまたは IP 変更リンク | 30 日に 1 回、パッケージの全アドレスを交換 |
| 商品 | Residential | IPv4 |
購入、パッケージ一覧、パッケージの詳細は両方の種類に共通のルートです。片方の種類にしかない 操作は別に説明しています: トラフィック と 固定アドレス。
ベース URL と認証
Section titled “ベース URL と認証”https://ipv.rentcurl https://ipv.rent/api/v1/balance \ -H 'Authorization: Bearer YOUR_API_KEY'登録は app.ipv.rent で行い、その後メールアドレスを確認します。 確認しないとログインできません。
キーはダッシュボードで発行します: プロフィール → APIキー → キーを作成。シークレットは一度だけ 表示されます。有効なキーは 1 アカウントあたり最大 20 個です。
取り消したキーは直ちに受け付けられなくなり、イベントログに api_key.revoked イベントが
記録されます。
401 invalid_api_key - キーが受け付けられません。403 insufficient_scope - ルートが必要とする
権限がキーにありません。
すべてのフィールドと例を含むリクエストとレスポンスのスキーマは OpenAPI リファレンス にあります。
権限を指定せずに発行したキーはすべての権限を持ちます。発行済みのキーの権限は変更できません。
| 権限 | 利用できるもの |
|---|---|
catalog:read | 商品とそのパラメータ、ジオカタログ、価格計算 |
packages:read | パッケージ一覧、パッケージの詳細、延長の選択肢 |
packages:write | 購入とパッケージのすべての操作: 容量の追加、接続、パスワード、延長、アドレスの交換、フィンガープリント、自動更新 |
orders:read | 注文 |
orders:write | 予約済み - 現時点でこれを必要とするルートはありません |
billing:read | 残高と取引 |
events:read | イベントログ |
カタログと購入 - 両方の種類:
| ルート | 権限 | Idempotency-Key |
|---|---|---|
GET /api/v1/products | catalog:read | - |
GET /api/v1/products/{product}/options | catalog:read | - |
POST /api/v1/quote | catalog:read | 不要 |
POST /api/v1/packages | packages:write | 必須 |
GET /api/v1/packages | packages:read | - |
GET /api/v1/packages/{id} | packages:read | - |
POST /api/v1/packages/{id}/password | packages:write | 不要 |
Residential のみ:
| ルート | 権限 | Idempotency-Key |
|---|---|---|
GET /api/v1/geo/countries, /states, /cities, /asns | catalog:read | - |
POST /api/v1/packages/{id}/proxies | packages:write | 不要 |
POST /api/v1/packages/{id}/topup | packages:write | 必須 |
POST /api/v1/packages/{id}/rotation-secret | packages:write | 不要 |
IPv4 のみ:
| ルート | 権限 | Idempotency-Key |
|---|---|---|
GET /api/v1/packages/{id}/prolong-options | packages:read | - |
POST /api/v1/packages/{id}/prolong | packages:write | 必須 |
POST /api/v1/packages/{id}/replace | packages:write | 不要 |
POST /api/v1/packages/{id}/fingerprint | packages:write | 不要 |
POST /api/v1/packages/{id}/renewal | packages:write | 不要 |
アカウント:
| ルート | 権限 | Idempotency-Key |
|---|---|---|
GET /api/v1/orders, /orders/{id} | orders:read | - |
GET /api/v1/balance, /transactions | billing:read | - |
GET /api/v1/events | events:read | - |
別の種類の操作をパッケージに行うと 422 unsupported_capability が返ります。
残高のチャージ とキーの管理はダッシュボードでのみ行えます。
キーごとに毎分 120 リクエスト、加えて何かを変更するリクエスト (POST) は毎分 30 です。
すべてのレスポンスに RateLimit-Limit、RateLimit-Remaining、RateLimit-Reset が付きます。
超過すると retry_after と Retry-After 付きの 429 が返ります: 指定された秒数待ってから
再試行してください。
Telegram: @ipvrent_support、メール
[email protected]。エラー本文の request_id を添えてください。
ニュースとサービスの稼働状況はチャンネル t.me/ipvrent でお知らせします。