API-Referenz

Integrieren Sie die Duplikaterkennung von True Record über REST-API in Ihre Workflows.

Basis-URL

https://truerecord.app/api/v1

Alle API-Anfragen erfordern ein Bearer-Token.

Authorization-Header-Format

Authorization: Bearer tr_xxxxxxxxxxxxxxxx

API-Schlüssel sind auf bestimmte Berechtigungen beschränkt.

GET/org/status

Organisationsinformationen abrufen.

Scope: org:read

POST/scan/start

Neuen Scan starten.

Scope: scans:write

GET/scan/status/:scanId

Scan-Ergebnisse abrufen.

Scope: scans:read

GET/matches

Duplikat-Treffer abrufen.

Scope: matches:read

POST/matches/:matchId/merge

Treffer zusammenführen.

Scope: matches:merge

POST/matches/:matchId/dismiss

Treffer verwerfen.

Scope: matches:dismiss

Ratenlimits variieren je nach Plan:

Ratenlimit-Header sind in jeder Antwort enthalten.

Alle Fehler folgen einem einheitlichen Format:

400Bad Request - Ungültige Parameter

401Unauthorized - Ungültiger API-Schlüssel

403Forbidden - Unzureichende Berechtigungen

404Not Found - Ressource existiert nicht

429Too Many Requests - Ratenlimit überschritten

500Internal Server Error

Weitere Ressourcen