API REST Newforma Konekt

4 minutes
Il y a 11 mois

La version 3 de notre API REST est maintenant disponible. Il est important de migrer vers cette version le plus rapidement possible, surtout si vous avez un hub aux États-Unis et que votre organisation de se conformer à toute politique de souveraineté des données en place dans son organisation. Un soutien continu sera apporté à ceux qui utilisent la v2 jusqu’à la fin de 2020.

L’API REST de Newforma Konekt permet aux développeurs de trouver, créer ou modifier les données Newforma Konekt. Elle donne accès à toutes les principales fonctions fournies dans l’interface Web. Les deux principaux cas d’utilisation sont l’extraction d’informations et la connexion à Power BI, mais les possibilités sont infinies.

Nos propres add-ins utilisent l’API REST Newforma Konekt, ce qui signifie que tout est entièrement testé. Plusieurs intégrations telles que Cintoo l’utilisent également pour synchroniser les questions.

Environnements

Notre API de production est liée aux services réguliers et l’environnement de test aux services bêta. Veuillez noter que le service bêta n’est pas le service régulier de BIMTrackapp et qu’il est utilisé pour obtenir un accès rapide aux fonctionnalités et à la version de l’API.

Production

Beta sandbox

Dans v2, une ressource typique était identifiée par une url similaire à /v2/hubs/1234/projets/9876, tandis que dans v3, la même url de ressource est /v3/hubs/zAY4HPj0/projets/9876.

Pré-requis à l’utilisation de l’API

  • Pour utiliser l’API Newforma Konekt REST, vous devez disposer d’un compte Newforma Konekt. Vous pouvez vous créer un compte gratuit ou, si vous avez été invité à collaborer sur un projet, activer votre compte depuis le courriel d’activation que vous avez reçu. Pour les développeurs de logiciels tiers, une fois votre compte créé, veuillez remplir le formulaire sur notre page API et l’équipe vous contactera dès que possible.
  • Un jeton d’accès est également nécessaire. L’API prend en charge l’authentification par un jeton API et l’authentification par un jeton OAuth2. Si vous développez une intégration, nous vous recommandons d’utiliser OAuth2. Contactez-nous pour obtenir votre client ID et secret ID. Ces valeurs ne seront générées qu’une seule fois.
    Veillez à ne pas dévoiler votre client ID et secret ID et à ne les communiquer qu’aux intervenants légitimes par des canaux sécurisés.

FAQ

Comment changer le point de vue sur une question ?

Regardez cette vidéo en anglais : Issue viewpoints interaction

Pourquoi est-ce que j’obtiens beaucoup de réponses « dépassement de quotas » ?

La limite d’appel de l’API est de 10 par seconde. Vous recevrez un message d’erreur si vous atteignez la limite. Cela se produit la plupart du temps lorsque vous recevez les données périodiquement.

Il s’agit d’un flux de travail pris en charge, mais nous vous suggérons de ne pas obtenir les données de toutes les questions dans tous les projets de votre hub, car cela entraîne les erreurs d’étranglement que vous obtenez. Selon la manière dont vous traitez ces erreurs, cela peut conduire à un ensemble de données incomplet.

Une approche différente pour obtenir les données consiste à n’obtenir que les questions qui ont été créées/mises à jour depuis la dernière exécution. Pour ce faire, vous pouvez trier les données par date de dernière modification (ordre décroissant), puis arrêter de récupérer les questions lorsque la « date de dernière modification » est inférieure à la dernière fois que la requête a été exécutée.

Cette méthode est beaucoup plus efficace, car vous n’obtiendrez qu’un sous-ensemble des données, qui peuvent à leur tour être mises à jour dans votre propre stockage de données.

Soutien technique

Si vous avez besoin d’une assistance technique, veuillez nous contacter directement par le biais de l’application ou du chat en ligne. Nous disposons également d’une communauté privée qui sert de forum pour les partenaires.