Vue d'ensemble

Introduction

Pour commencer

Développement et lancement

Soutien

Soutien

Introduction

Utilisations de l'intégration

L'API STACK vous permet de connecter STACK directement à d'autres solutions logicielles, créant ainsi un flux de travail transparent adapté aux besoins de votre entreprise.

Les intégrations peuvent être utilisées pour extraire les plans et les documents du projet, directement à partir du document du projet de construction ou de la solution de gestion de l'offre, dans STACK pour le processus de prise en charge et d'estimation.

Ils peuvent également être utilisés pour transmettre des données d'estimation et des propositions à des solutions logicielles de comptabilité et de gestion de projet.

Cela signifie un meilleur suivi des projets, une analyse plus claire des données, une réduction des saisies manuelles et une diminution des reprises.

Les fonctionnalités de base comprennent la création de projets et de plans, la création de listes prises de mesures , la gestion des articles et des assemblages, la récupération des quantités et des coûts, et le téléchargement de plans et de propositions.

Seuls les appels d'API publiés dans le document STACK Developers Reference sont pris en charge. Les clients qui mettent en œuvre des points finaux d'API non publiés le font à leurs propres risques.

Types d'intégration

Intégration personnalisée - Réservé à l'usage de votre entreprise

Une intégration personnalisée est une connexion entre votre compte STACK , que vous utilisez et contrôlez, et un autre système utilisé au sein de votre entreprise.

Ils sont généralement créés par les clients de STACK pour rendre leur équipe plus efficace en automatisant les mouvements de données et les flux de travail manuels entre STACK et l'autre système.

Seuls vous et votre équipe aurez accès à votre intégration personnalisée.

Intégration des partenaires - Pour tous les utilisateurs de STACK

Une intégration partenaire est généralement créée par une autre société technologique pour connecter son application à STACK au profit de nos clients mutuels.

Ces intégrations peuvent être listées sur la place de marché STACK afin d'être accessibles à l'ensemble de la communauté STACK .

Vous trouverez ici une liste des intégrations des partenaires actuels.

Exemple de flux de travail d'intégration

Avant de commencer le développement, il est utile de planifier chaque étape du processus d'intégration proposé et de dresser la liste des données qui seront transférées entre les systèmes associés à chaque étape.

Vous trouverez ci-dessous un modèle de flux de travail vierge et un exemple complété à titre de référence.

Exigences

La création d'une intégration avec l'API STACK nécessite une programmation qui n'est pas effectuée par STACK.

Pour utiliser l'API, vous devez être au moins un programmeur de niveau débutant ayant une connaissance de base des langages de programmation, des interfaces logicielles, de l'autorisation OAuth, des API et des concepts de développement web.

Si vous n'êtes pas un programmeur ou si vous n'avez pas besoin d'en avoir un dans votre équipe, vous pouvez confier le travail de programmation à un tiers.

Pour accéder à l'API, vous devez être un client de STACK et avoir souscrit un abonnement API.

Si vous n'êtes pas encore client, mais que vous êtes intéressé par la création d'une intégration de partenaire, veuillez nous contacter pour discuter de votre projet d'intégration et des options possibles.

Pour commencer

Demande d'accès à l'API

La première étape pour créer une intégration avec l'API STACK est de demander l'accès à l'API.

Pour accéder à l'API, vous devez être un client de STACK et avoir souscrit un abonnement API.

Si vous n'êtes pas encore client, mais que vous êtes intéressé par la création d'une intégration de partenaire, vous pouvez toujours demander un accès pour entamer la discussion sur ce que vous souhaitez créer et sur la manière de devenir partenaire.

Dans les deux cas, il suffit de cliquer sur le bouton Demander l'accès à l'API en haut de la page, de remplir le formulaire de demande et de le soumettre.

Notre équipe examinera la demande et répondra dans les deux jours ouvrables pour organiser un appel de lancement de l'API afin de discuter de l'intégration et du flux de travail proposés.

Après l'appel de lancement, si vous êtes d'accord pour aller de l'avant, nous vous enverrons par courriel des instructions sur la façon de créer un compte partenaire pour obtenir les identifiants de l'API.

Compte et références du partenaire

Pour construire une intégration avec STACK, vous avez besoin d'un compte partenaire. Il s'agit d'un compte STACK qui sera lié à vos identifiants API.

Même si votre intégration se connecte directement à un compte client et ne met aucune donnée dans le compte partenaire, un compte partenaire est nécessaire à des fins de journalisation.

Vous créerez d'abord un compte partenaire dans l'environnement de test d'acceptation des partenaires (PAT). (Vous devrez créer un autre compte lorsque vous passerez à l'environnement de productionSTACK ).

Nous vous enverrons par courriel les instructions nécessaires à la création d'un compte partenaire après l'appel de lancement de l'API.

Une fois le compte créé, indiquez-nous l'adresse électronique que vous avez utilisée et nous vous enverrons un courrier électronique crypté contenant les informations d'identification de l'API (identifiant et secret de l'utilisateur du partenaire) nécessaires pour accéder à notre environnement de test d'acceptation du partenaire (PAT).

Authentification

Chaque fois que vous faites une demande à l'API STACK , vous devez être autorisé par le serveur d'autorisation de STACK.

Vous devez comprendre le processus d'autorisation et suivre les étapes d'authentification avant de commencer à travailler avec l'API.

OAuth 2.0 - L'autorisation à deux jambes

L'autorisation bilatérale est utilisée lorsque votre intégration écrit des données dans un compte que vous contrôlez ou lit à partir de ce compte. Il s'agit typiquement d'une communication de serveur à serveur où vous pouvez créer des projets, des plans, des fichiers directement dans votre propre compte.

OAuth 2.0 - L'autorisation à trois pattes

L'autorisation à trois pattes est utilisée lorsque votre intégration écrit des données dans un compte ou lit des données à partir d'un compte au nom d'un utilisateur. L'utilisateur doit alors accorder à votre intégration la permission de contrôler ses données. Votre application demandera à contrôler le compte d'un utilisateur et celui-ci devra cliquer sur un bouton pour accorder à votre application les permissions appropriées.

Cliquez pour consulter la documentation complète sur l'authentification.

Développement et lancement

Environnement de test - Bac à sable

Vous construirez et testerez votre intégration dans notre environnement PAT (Partner Acceptance Testing), communément appelé "bac à sable".

Cela vous permet d'alimenter les données de test et de vérifier que tous vos appels API fonctionnent comme prévu avant de vous connecter à l'environnement de production STACK .

Toutes les intégrations doivent être certifiées dans l'environnement PAT par STACK avant d'être transférées dans l'environnement de production.

Reportez-vous à la section Demande d'accès à l'API pour obtenir des instructions sur l'accès à l'environnement PAT.

REMARQUE : vous trouverez des tutoriels pour les fonctions d'intégration courantes dans la section Tutoriels de ce site.

Toute la documentation de l'API est disponible dans la Référence API.

Certification

Toutes les intégrations doivent être certifiées par STACK avant de passer à l'environnement de production.

Cela garantit que l'API mise en œuvre fonctionne comme prévu, fournit une interaction sûre et prévisible et peut être prise en charge par STACK à l'avenir.

Le processus de certification dure environ 2 heures - vous suivrez un flux de travail normal pendant que nous contrôlons l'utilisation de l'API.

Une fois la certification terminée, vous recevrez les résultats :

- Si l'intégration est réussie, vous recevrez des instructions sur la manière de passer à l'environnement de production.
- Si l'intégration a échoué, vous recevrez une liste des éléments obligatoires à corriger, ainsi que des éléments facultatifs permettant d'améliorer l'efficacité de l'intégration. Une fois les éléments obligatoires corrigés, nous pourrons recommencer le processus de certification.

Environnement de production

Une fois que votre intégration a passé le processus de certification, nous vous enverrons par e-mail les instructions pour créer un compte partenaire de production afin que vous puissiez passer à l'environnement de production.

Une fois le compte créé, vous devrez nous communiquer l'adresse électronique utilisée et votre clé publique. Nous vous enverrons ensuite un courriel crypté contenant les informations d'identification de l'API de production - l'identifiant du client et le secret.

À ce stade, vous êtes prêt à passer en ligne. Félicitations !

L'image de marque

Lorsque vous représentez STACK sur votre site, veuillez vous référer à ces lignes directrices :

- Le nom STACK doit toujours être écrit en majuscules.
- Le logo STACK ne doit pas être manipulé ou déformé de quelque manière que ce soit.
- La taille minimale du logo STACK à l'écran est de 80 px.
- La police de la marque STACK est Proxima Nova. C'est la police préférée, mais elle n'est pas obligatoire. Si vous n'utilisez pas Proxima Nova, veillez à utiliser une police sans serif adaptée au web comme Arial, Helvetica, etc.

Lorsque vous redirigez un client vers STACK à partir de votre application, une bannière ou un bouton comme celui-ci peut être approprié :

Nous vous fournirons le fichier du logo et les couleurs utilisées dans les exemples de boutons.

Soutien

Nous souhaitons que votre connexion à l'API STACK soit aussi transparente que possible.

Si vous avez des questions, veuillez envoyer un courriel à l'adresse suivante apihelp@stackct.com. (Veillez à indiquer votre nom et votre nom d'utilisateur STACK dans l'e-mail).