開発者向け
RefurbScore API
企業データ、パスポート、レビュー、マーチャント統合のREST API。
- ベースURL
https://refurbscore.com
認証
マーチャントエンドポイントにはAPIキー(Proプラン)が必要です。Authorization BearerまたはX-API-Keyヘッダーでキーを渡してください。
Authorization: Bearer rs_live_…
# または
X-API-Key: rs_live_…コマンド全体を読むには、横にスクロールしてください。
利用可能なスコープ:
read:companyread:passportwrite:passportwrite:reviewwrite:editwrite:webhook
スコアの独立性
APIは検証済みデータから計算された信頼スコアを公開します。有料プランとAPIアクセスはスコアを変更しません。
レート制限
- 公開読み取り
- 60req/分
- 認証済み
- 300req/分
- 書き込み操作
- 30req/分
レスポンスにはX-RateLimit-RemainingとX-RateLimit-Resetヘッダーが含まれます。
エンドポイント
パスはベースURLからの相対パスです。「公開」エンドポイントはAPIキー不要で、IPアドレスごとにレート制限があります。
- GET
/api/company/{slug}認証: 公開スコープ:read:company - GET
/api/company/{slug}/score認証: 公開スコープ:read:company - GET
/api/company/{slug}/reviews認証: 公開スコープ:read:company - GET
/api/passport/{id}認証: 公開スコープ:read:passport - POST
/api/passport認証: APIキースコープ:write:passport - POST
/api/reviews認証: オプションスコープ:write:review - POST
/api/suggested-edit認証: APIキースコープ:write:edit - POST
/api/webhooks認証: APIキースコープ:write:webhook
例
curl "https://refurbscore.com/api/company/nomophone"コマンド全体を読むには、横にスクロールしてください。
curl -X POST "https://refurbscore.com/api/passport" \
-H "Authorization: Bearer rs_live_…" \
-H "Content-Type: application/json" \
-d '{"brand":"Apple","model":"iPhone 13","condition":"A","summary":"128GB"}'コマンド全体を読むには、横にスクロールしてください。
curl -X POST "https://refurbscore.com/api/webhooks" \
-H "Authorization: Bearer rs_live_…" \
-H "Content-Type: application/json" \
-d '{"action":"register","url":"https://example.com/hook","events":["review.published"]}'コマンド全体を読むには、横にスクロールしてください。
イベント
review.createdreview.publishedpassport.createdpassport.publishedscore.updatedcertification.updated
セキュリティ
- すべての書き込み操作は公開前に管理者モデレーションに入ります。
- APIキーはSHA-256ハッシュとして保存されます — 生のキーは作成時に一度だけ表示されます。
- Webhook配信はX-Webhook-Signature(HMAC-SHA256)を検証する必要があります。
- すべてのリクエストはメソッド、パス、ステータス、期間、キープレフィックスとともにログに記録されます。