Aller au contenu
Arcane CRMArcane CRMAide

Atlas

Répond à partir de cette aide et cite ses sources. 20 questions par jour.

Clés d'API

L’API externe permet à vos autres outils (site web, formulaire, ERP, outil d’automatisation…) de lire et d’écrire des fiches du CRM. Chaque clé appartient à l’organisation : elle agit au nom d’un compte de service de l’organisation, qui ne prend pas de siège, et seulement sur les objets que vous lui ouvrez.

Selon votre offre Réglages › Intégrations › Clés API L'Owner et les Admins
1234
  1. 1Nouvelle clé
  2. 2Adresse de l'API
  3. 3Une clé et ses objets
  4. 4Révoquer
Survolez un numéro pour repérer la zone. Cliquez sur la capture pour l'agrandir.
La page Clés API : le bouton Nouvelle clé, l'adresse de l'API, et la clé Synchro site web, active, avec ses objets autorisés, sa date de création, sa dernière utilisation et le bouton Révoquer.

Créer une clé

Section intitulée « Créer une clé »
La fenêtre Nouvelle clé API : le nom, l'expiration, les objets autorisés en lecture ou en écriture, et la case Lancer les workflows.
  1. Cliquez sur Nouvelle clé et donnez-lui un nom qui dit quel outil l’utilise.
  2. Choisissez l’expiration : 30 jours, 90 jours, 1 an ou sans expiration.
  3. Dans Objets autorisés, cochez Lecture ou Écriture pour chaque objet. L’écriture comprend la lecture et permet de créer, modifier, archiver et restaurer des fiches. Tous les objets vaut aussi pour les objets créés plus tard.
  4. Cochez Lancer les workflows si l’outil doit déclencher vos workflows actifs qui commencent par un « Appel d’API » (voir Déclencheurs). Cette case n’est jamais comprise dans « Tous les objets ».
  5. Cliquez sur Créer la clé, copiez-la, puis cliquez sur J’ai copié la clé.

Une organisation a au plus 25 clés actives.

Utiliser l’API

Section intitulée « Utiliser l’API »

L’adresse de l’API s’affiche en haut de la page. Chaque requête envoie la clé dans l’en-tête Authorization: Bearer <clé>. L’API permet de lister les objets et leurs champs, de chercher, lire, créer, modifier, archiver et restaurer des fiches, et de créer ou mettre à jour jusqu’à 100 fiches en une requête en les reconnaissant par un champ (un e-mail, par exemple).

Par exemple, pour créer un contact :

Fenêtre de terminal
curl -X POST https://api.arcane-crm.com/v1/records/crm_contacts \
  -H "Authorization: Bearer crm_sk_…" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Jeanne","last_name":"Roux","email":"[email protected]"}'

L’API répond 201 avec la fiche créée dans data.

  • Les fiches créées sans propriétaire ont pour propriétaire le compte de service.
  • Toutes les modifications sont inscrites au journal d’audit avec le nom de la clé.
  • Le nombre de requêtes par minute et par clé dépend de votre offre. Au-delà, l’API répond d’attendre.
  • Une clé survit au départ de la personne qui l’a créée.

Révoquer une clé

Section intitulée « Révoquer une clé »

Révoquer refuse la clé dès la requête suivante, définitivement : les outils qui l’utilisent cessent de fonctionner. La clé reste listée avec l’état Révoquée ; une clé arrivée à échéance passe en Expirée.