Une API (Application programming interface) est "une interface ou un protocole de communication entre un client et un serveur".
En d'autres termes, c'est une manière d'extraire des informations d'un programme et de les transférer vers un autre.
L'API Rentman (qui est une API publique) vous permet de créer vos propres intégrations avec d'autres programmes. Dans cet article, nous vous offrons un aperçu général de l'API Rentman et les instructions vous permettant d'y accéder.
Obtenez votre token API
Pour utiliser l'API Rentman, vous devez générer un token API. Ce Token API est personnalisé et utilisé pour votre authentification – comme un mot de passe. Veillez à ne pas partager ce token avec quelqu'un d'autre (lire nos conseils pratiques pour la sécurité relative à l'API). Veuillez noter que le token API est désormais disponible pour 10 ans au lieu de 5. Ce changement ne s'applique qu'aux nouveaux tokens Au bout de 10 ans, vous devrez les générer à nouveau.
Pour générer votre Token :
- Allez dans settings Configuration > Compte > Intégrations.
- Si désactivée, cliquez sur Connecter dans le champ "API".
- Cliquez sur Afficher token.
Vous pouvez à présent utiliser ce token pour créer vos intégrations d'API. Si vous souhaitez créer un nouveau token, cliquez sur Régénérer token. L'ancien token sera invalide.
Documentation API publique Rentman
Lisez attentivement notre Documentation Rentman API pour avoir accès à toutes les informations concernant l'authentification, les titres, les requêtes et limitations de notre API ouverte. Vous y trouverez également tous les codes nécessaires pour les différents appels API.
Conseils pratiques pour la sécurité de l'API
Les tokens API donnent accès à votre compte Rentman et vous devez les protéger de la même manière que vous protégeriez votre mot de passe. Vous trouverez ci-dessous quelques bonnes pratiques communes pour la sécurité API :
- N'exposez pas votre API token au public (dans des captures d'écran ou vidéos par exemple). Remarque : flouter vos informations n'est pas toujours suffisant. Il est préférable d'utiliser les fonctions "couper" pour supprimer complètement ces informations.
- Si vous devez partager votre token, générez en un nouveau après avoir rendu l'ancien invalide.
- N'envoyez jamais votre API token par email, cela donnerait accès aux informations de votre compte si des hackers parvenaient à accéder à votre adresse e-mail.
- L'accès à chaque appel API est déterminé par le rôle de l'utilisateur qui a généré le token API.
Consultations API
Si vous travaillez sur une intégration personnalisée avec un développeur interne (ou externe), notre spécialiste du support technique peut l'accompagner et répondre à ses questions concernant notre documentation API. Nous ne participons pas à la programmation/construction des intégrations, mais nous pouvons donner des conseils sur d’autres sujets via ce lien.