ホームに戻る

APIリファレンス

REST APIでTrue Recordの重複検出をワークフローに統合します。

ベースURL

https://truerecord.app/api/v1

認証

すべてのAPIリクエストにはBearerトークンが必要です。

Authorizationヘッダー形式

Authorization: Bearer tr_xxxxxxxxxxxxxxxx

APIキーを作成

APIスコープ

APIキーは特定の権限にスコープされています。

Scope	Description
`scans:read`	スキャンステータスを表示
`scans:write`	スキャンを開始
`matches:read`	マッチを表示
`matches:merge`	マージを実行
`matches:dismiss`	マッチを却下
`import:read`	インポートを表示
`import:write`	インポートを実行
`org:read`	組織情報を表示
`*`	フルアクセス

エンドポイント

GET/org/status

組織情報を取得。

Scope: org:read

POST/scan/start

新しいスキャンを開始。

Scope: scans:write

GET/scan/status/:scanId

スキャン結果を取得。

Scope: scans:read

GET/matches

マッチを取得。

Scope: matches:read

POST/matches/:matchId/merge

マッチをマージ。

Scope: matches:merge

POST/matches/:matchId/dismiss

マッチを却下。

Scope: matches:dismiss

レート制限

レート制限はプランによって異なります：

プラン	リクエスト/分
Professional	60
Business	120
Enterprise	300

レート制限ヘッダーはすべてのレスポンスに含まれます。

エラーレスポンス

すべてのエラーは一貫した形式に従います：

400Bad Request - 無効なパラメータ

401Unauthorized - 無効なAPIキー

403Forbidden - 権限不足

404Not Found - リソースが存在しない

429Too Many Requests - レート制限超過

500Internal Server Error

リソース

APIキーを管理セキュリティ

ドキュメントに戻る