エンドポイントリファレンス

Reseller API

すべてのエンドポイントは application/json を返します。エラーは RFC 7807(Problem+JSON)に準拠します。すべてのレスポンスにはサーバー側監査ログとの相関のために X-Request-Id ヘッダーが含まれます。

MethodPathスコープ用途
GET/v1/healthpublic認証不要のヘルスチェック。
GET/v1/meany自身のアカウント情報およびキーメタデータ。
GET/v1/productsread:products公開されているすべての製品の価格付き一覧。
GET/v1/products/{id}read:products設定オプションを含む製品詳細。
POST/v1/orderswrite:orders発注。Idempotency-Key が必須です。
GET/v1/orders/{id}read:orders自身の注文ステータス。
GET/v1/servicesread:services自身のサービス一覧(ページネーション対応)。
GET/v1/services/{id}read:services自身のサービス詳細。
GET/v1/services/{id}/credentialsread:credentialsサービス認証情報(専用スコープ、監査ログあり)。
POST/v1/services/{id}/actionswrite:servicesサービスアクション:start、stop、reboot、reinstall、suspend、unsuspend、terminate。
GET/v1/billing/balanceread:billingクレジット残高。
GET/v1/billing/invoicesread:billing請求書の一覧(ページネーション対応)。
GET/v1/billing/invoices/{id}/pdfread:billing請求書 PDF。
GET/v1/webhooksread:webhooks現在の Webhook URL。
PUT/v1/webhookswrite:webhooksWebhook URL の設定または解除。

冪等性

POST /v1/orders および POST /v1/services/{id}/actions では Idempotency-Key ヘッダー([A-Za-z0-9_.-] から成る 1~80 文字)が必須です。サーバーはレスポンスとボディハッシュを 24 時間キャッシュします。同じキーかつ同じボディの 2 回目のリクエストは同じレスポンスを返し、同じキーでもボディが異なる場合は 409 idempotency_conflict として拒否されます。

レート制限

デフォルトはキーごとに 60 req/分(20 のバースト許容)かつ 5000/日、加えてキーに依存しない IP ごとの 600 req/分です。超過した場合は HTTP 429 と Retry-After ヘッダーが返ります。レスポンスヘッダー X-RateLimit-Remaining および X-RateLimit-Reset で現在の状況を確認できます。