Retour à l'accueil

Référence API

Intégrez la détection de doublons True Record dans vos workflows via l'API REST.

URL de base

https://truerecord.app/api/v1

Authentification

Toutes les requêtes API nécessitent un token Bearer.

Format de l'en-tête Authorization

Authorization: Bearer tr_xxxxxxxxxxxxxxxx
Créer une clé API

Portées API

Les clés API sont limitées à des permissions spécifiques.

ScopeDescription
scans:readVoir le statut des scans
scans:writeLancer des scans
matches:readVoir les correspondances
matches:mergeFusionner
matches:dismissRejeter les correspondances
import:readVoir les imports
import:writeExécuter des imports
org:readVoir les infos org
*Accès complet

Points de terminaison

GET/org/status

Récupérer les informations de l'organisation.

Scope: org:read

POST/scan/start

Lancer un nouveau scan.

Scope: scans:write

GET/scan/status/:scanId

Récupérer les résultats du scan.

Scope: scans:read

GET/matches

Récupérer les correspondances.

Scope: matches:read

POST/matches/:matchId/merge

Fusionner une correspondance.

Scope: matches:merge

POST/matches/:matchId/dismiss

Rejeter une correspondance.

Scope: matches:dismiss

Limites de taux

Les limites varient selon le plan :

PlanRequêtes/min
Professional60
Business120
Enterprise300

Les en-têtes de limite sont inclus dans chaque réponse.

Réponses d'erreur

Toutes les erreurs suivent un format cohérent :

400Bad Request - Paramètres invalides
401Unauthorized - Clé API invalide
403Forbidden - Permissions insuffisantes
404Not Found - Ressource inexistante
429Too Many Requests - Limite dépassée
500Internal Server Error

Ressources