Aller au contenu
Glossaire

Qu'est-ce qu'une API ? Définition

Une API est une porte d'entrée qui permet à un logiciel de lire ou de modifier les données d'un autre, selon des règles précises.

Qu'est-ce qu'une API ?

Une API (Application Programming Interface, interface de programmation) est un ensemble de règles qui permet à un logiciel d'interroger un autre logiciel : lire des données, en créer, en modifier. C'est l'équivalent, pour un programme, de l'écran que vous utilisez à la main.

L'accès est protégé : chaque appel présente une clé ou un jeton qui dit au nom de qui il agit et ce qu'il a le droit de faire.

Pourquoi c'est important pour la prise de rendez-vous

Une API permet de relier vos rendez-vous à vos propres outils : afficher les prochains rendez-vous dans un intranet, créer un lien unique depuis un logiciel métier, annuler un rendez-vous depuis une autre application. Elle complète le webhook, qui prévient vos outils au lieu d'attendre leurs questions.

Exemple

Une agence immobilière fait créer, par son logiciel de gestion, un lien unique de visite pour chaque acheteur intéressé, puis lit les rendez-vous pris pour les afficher sur la fiche du bien.

Dans Artibox Calendar

Chaque membre crée ses jetons personnels dans Réglages › Intégrations, carte « API ». Un jeton agit en votre nom dans l'organisation, avec les seules portées choisies (lire les types, lire les rendez-vous, créer des liens…). Il s'envoie dans l'en-tête x-api-key, à raison de 100 appels par minute, et s'affiche une seule fois. Vous pouvez le révoquer à tout moment.

Un éditeur de logiciel peut aussi déclarer une application OAuth pour que d'autres comptes l'autorisent. L'API demande la formule Pro. Voir API et webhooks et l'aide sur l'API et les jetons.

Questions fréquentes

Un jeton peut-il tout faire dans mon organisation ?

Non. Il n'a que les portées cochées à sa création, et jamais plus que ce que votre rôle permet.

J'ai perdu mon jeton, comment le retrouver ?

Un jeton ne s'affiche qu'une fois. Révoquez l'ancien et créez-en un nouveau.

Reliez vos outils à vos rendez-vous

L'API est incluse dès la formule Pro, et pendant l'essai gratuit.

Essayer gratuitement

Termes liés

  • Webhook

    Un webhook est un message envoyé automatiquement par une application à une adresse web dès qu'un événement se produit.

  • OAuth

    OAuth est un standard qui permet d'autoriser une application à agir sur un compte, sans lui donner son mot de passe. L'accès se retire à tout moment.

  • CRM

    Un CRM (gestion de la relation client) est le logiciel où une entreprise centralise ses contacts, ses échanges et ses ventes.