Clés API et l'API

Une clé API est un mot de passe qui appartient à un programme plutôt qu'à une personne. Traitez-la de la même manière : émettez-en une par système et remplacez-la lorsque ce système change.

Créer une clé

1. Ouvrir API → Gestion de l'API et appuyez sur Nouvelle clé.
2. Donnez-lui un nom qui indique quel système l'utilise.
3. Choisissez son Autorisations: Accès complet, ou seulement les zones dont le système a besoin. La plupart des zones distinguent la lecture, la création et la modification.
4. Choisissez une date d'expiration, ou aucune.
5. Utiliser Afficher et Copier sur la carte de clé pour transmettre la clé au système appelant. Le système l'envoie dans le authtoken en-tête.

Chaque carte-clé montre les autorisations, la date de création, Dernière utilisation et un badge tel que « actif » ou « expire dans 5 jours ».

Renouveler une clé avant son expiration

Quatorze jours avant l'expiration d'une clé, vous recevez une notification dans la cloche. Appuyez sur Renouveler sur la carte de clé et choisissez la nouvelle date d'expiration. IDup crée une nouvelle clé avec les mêmes autorisations. Copiez-la immédiatement, car cet affichage apparaît une seule fois. L'ancienne clé reste valide jusqu'à sa propre expiration, vous pouvez donc basculer le système sans interruption.

Les zones que vous pouvez atteindre

L'API couvre vos données clients et, selon votre plan, les propriétés et locations, les profils de recherche, les dossiers fiscaux, les dossiers de fiducie, la comptabilité, les exécutions de paie et la numérisation des reçus. AI Studio et la boîte de réception ont leurs propres domaines. Le guide de l'API répertorie uniquement les domaines inclus dans votre plan.

Le guide de l'API

Ouvrir le Documentation onglet sur la page de gestion de l'API, ou API → Guide de l'API. Chaque zone affiche ses champs, des exemples de requêtes que vous pouvez copier, des exemples de réponses et des codes d'erreur.

Webhooks et autres interfaces

• Le Webhooks onglet envoie des événements à votre système au fur et à mesure qu'ils se produisent — voir Envoyer des événements à votre propre système avec des webhooks.
• Si l'API Client est activée, un Paramètres API Clients onglet ouvre ses paramètres, par exemple si les clients peuvent s'inscrire via l'API.
• Automatisation / flux de travail → Interface technique émet un jeton pour l'interface GraphQL.
• AI Studio → Clés API personnelles est un ensemble distinct de clés.

Conserver en sécurité

1. Une clé par système, jamais partagée.
2. Donnez à une clé uniquement les autorisations nécessaires au système.
3. Définissez une date d'expiration et renouvelez selon un calendrier.
4. Supprimer une clé dès qu'une personne qui la connaissait part, ou que le système est éteint.