Contexte
API est un acronyme anglais qui signifie « Application Programming Interface », que l'on traduit par interface de programmation d'application.
Fieldwire propose une API REST (REpresentational State Transfer) aux clients avec une abonnement payant. Les clients Pro, Business, ou Business Plus peuvent également accéder à l’API en collaboration avec notre équipe commerciale.
Demandez une démo si vous souhaitez savoir davantage sur notre API et/ou modifier votre abonnement afin d’y accéder.
Accès à l'API : comment faire ?
La marche à suivre dépend du fait que l'accès à l'API soit déjà activé ou non sur votre compte.
- SI l'accès à l'API est déjà activé sur votre compte, ALORS vous pouvez générer un jeton API en suivant les étapes décrites dans la section « Comment générer des clés API » ci-dessous ET aucun contact supplémentaire avec le service commercial n'est nécessaire.
- SI l'accès à l'API n'est PAS activé sur votre compte, ALORS vous devrez contacter notre équipe commerciale pour mettre à niveau votre compte ou ajouter l'accès à l'API à votre forfait actuel ET vous ne pourrez PAS générer de jetons API tant que l'accès à l'API n'aura pas été activé.
Les fonctionnalités de notre API
Vous pouvez profiter de toutes les fonctionnalités de Fieldwire (et encore plus !) avec notre API, tout en codant. Avec l’API, nos clients peuvent exporter en masse des données des projets depuis d’autres plateformes vers Fieldwire, synchroniser leurs données entre Fieldwire et d’autres logiciels et copier automatiquement les plans et les documents de Fieldwire sur leurs serveurs. L’API leur permet d’analyser rapidement les données sur plusieurs projets. Et ce n’est que le début !
- Consultez notre documentation API
- Inscrivez-vous à la newsletter de notre documentation API
Accès développeur et clés API
Les propriétaires et les responsables de compte peuvent demander et vérifier l’accès à l’API sur la page d’accueil de l’application web, dans l’onglet « Compte », dans la section « Paramètres API ». Les propriétaires et les managers du compte peuvent également demander une clé d’accès à l’API à cet endroit.
Comment activer l’accès développeur ?
IMPORTANT : vous devez avoir déjà activé l'accès à l'API sur votre compte avant de demander un accès développeur. Si vous n'avez pas encore accès à l'API, veuillez consulter la section « Accès à l'API : déterminez la prochaine étape » ci-dessus.
1. Demandez une démo de l’API à notre équipe commerciale et souscrivez-vous à un compte Fieldwire Premium personnalisé avec accès à l’API.
2. Allez sur l’application web de Fieldwire, cliquez sur l’onglet « Compte » et faites défiler vers le bas jusqu’à la section « Paramètres API ».
3. Cliquez sur « Demande d’accès développeur API »
4. Une fenêtre s’ouvrira pour envoyer votre demande d’accès à l’API à support@fieldwire.com. Merci de renseigner un court message détaillant la nature de votre demande et cliquez sur le bouton bleu « Envoyer ».
5. Notre équipe vous répondra (le jour même) par mail pour confirmer l’activation de votre clé d’accès à l’API.
Comment générer des clés API
IMPORTANT:
- Vous ne pouvez générer des clés API que si les deux conditions suivantes sont remplies :
- L'accès API a été activé sur votre compte
- L'accès développeur a déjà été activé sur votre compte
SI vous ne voyez pas l'option « Gérer les jetons » dans les paramètres API, ALORS il vous reste peut-être une demande d'accès développeur à faire ou une confirmation que l'accès API a été activé.
1. Suivez les instructions détaillées ci-dessus pour activer votre accès développeur.
2. Retournez à la section « Paramètres API » sous l’onglet « Compte » de Fieldwire web. Vous verrez que le lien « Demande d’accès développeur API » a été remplacé par un nouveau lien « Gérer les jetons ». Si vous voyez le lien « Gérer les jetons », cliquez dessus.
Si vous voyez toujours le lien « Demande d’accès développeur API », vous devez encore suivre les étapes détaillées dans la section au-dessus.
3. Une nouvelle fenêtre s’ouvrira pour voir les jetons existants. Cliquez sur +Nouveau jeton pour générer une nouvelle clé API
Remarque : Vous pouvez générer jusqu'à 10 clés API ou jetons par compte Fieldwire. Assurez-vous que ces clés sont stockées de manière sécurisée et partagées uniquement avec les personnes autorisées.
4. Donnez un label à votre clé API, puis cliquez sur Créer.
5. Votre clé API s'affichera alors dans la même fenêtre.
Veuillez la conserver dans un endroit sécurisé. Une fois la fenêtre fermée, vous ne pourrez plus y accéder. Si vous fermez la fenêtre par inadvertance avant de sauvegarder la clé ou si vous souhaitez obtenir une nouvelle clé ultérieurement, vous devez retirer le jeton API et suivre à nouveau les étapes ci-dessus pour générer une nouvelle clé.
Remarque : Dès qu'une clé API est retirée, le jeton correspondant sera désactivé. Il faudra ensuite la remplacer par la nouvelle clé partout où vous l’aviez employée.
Si vous rencontrez des problèmes en récupérant votre clé d’accès à l’API après avoir suivi ces instructions, veuillez envoyer un mail à support@fieldwire.com
Résumé des requis
Pour générer un jeton API, toutes les conditions suivantes doivent être remplies :
- Votre compte inclut un accès API (via un plan payant ou ajouté par l'équipe commerciale)
- L'accès développeur a été demandé et approuvé
- Vous pouvez voir l'option « Gérer les jetons » dans les Paramètres de l'API de votre compte
SI au moins l'une de ces conditions n'est pas validée ALORS vous ne serez pas en mesure de générer des jetons API.
La Page développeur API
- Quand vous aurez récupéré votre clé d’accès à l’API, n'hésitez pas à consulter la page documentation développeurs API qui donne des astuces sur notre API.
- Pour voir les changements récents dans la structure de l'API, veuillez consulter notre changelog.
- Inscrivez-vous à la newsletter de notre documentation API
Remarque : les appels API sur les statuts personnalisés de Tâches ne sont pas encore visibles dans notre documentation API. Consultez plutôt ce guide pour ce type d'appels.
Plus d'informations