API Boréalis

L’API Boréalis: Qu’est-ce que c’est et comment l’utiliser ?

Date: 21 juillet 2021

Accès requis: Superutilisateurs

 

 

L’API de Boréalis est un outil puissant qui vous permet de mettre toutes vos applications au service de la mobilisation des parties prenantes. Cela peut sembler décourageant, mais c’est en fait très simple à utiliser ! Voyons comment mettre l’API à votre service.

 

Qu’est-ce que l’API Boréalis ?

L’API (qui signifie « interface de programmation applicative ») vous permet de connecter Boréalis aux autres outils que vous utilisez. Vous serez ainsi assuré que vous travaillez toujours avec des données complètes et à jour, tout en diminuant le travail d’entrée de données manuel. Cela inclut: les médias sociaux (Facebook, Twitter ou LinkedIn), les systèmes de gestion de la relation client (CRM), les systèmes d’information géographique (SIG), les systèmes de gestion de contenu (WordPress, Drupal), et bien d’autres.

 

Quels sont les avantages de l’utilisation de l’API ?

Toutes vos données dans Boréalis peuvent être transférées à d’autres applications ou importées de celles-ci. Une fois que vous aurez connecté vos applications via l’API, les données que vous souhaitez mettre à jour seront automatiquement synchronisées entre les systèmes. Voici quelques exemples :

 

Plateformes de médias sociaux
Acheminez les publications importantes sur les médias sociaux vers Boréalis en tant que communications pour les relier à vos parties prenantes importantes et à vos plans de participation. Créez des tableaux de bord personnalisés pour surveiller les publications quotidiennes, mensuelles et hebdomadaires.

 

Logiciel de gestion de relation client (CRM)
Créez une nouvelle entrée dans votre CRM et poussez-la automatiquement vers Boréalis. Tous les champs qui sont ajoutés ou mis à jour dans le CRM mettront automatiquement à jour les champs pertinents dans Boréalis. Vous pouvez également le configurer dans l’autre sens et pousser les nouvelles parties prenantes de Boréalis vers votre CRM.

Base de données SIG
Transférez les données géoréférencées de vos systèmes SIG vers Boréalis pour donner aux utilisateurs une représentation visuelle des actifs et des parties prenantes sur la carte de projet. Il est ainsi plus facile de planifier des stratégies de mobilisation ou de relier les griefs à un site de projet ou à un actif particulier.

 

Systèmes de gestion de contenu
Intégrer facilement les données de parties prenantes qui souhaitent contacter votre organisation via votre site web. Créez des formulaires dans votre CMS pour recueillir des informations auprès des individus puis importez les enregistrements directement dans Boréalis.

 

Pour plus d’informations, vous trouverez peut-être cet article utile.

 

L’API est-elle sécurisée ? 

Oui, elle l’est ! L’API que nous vous offrons utilise le même niveau de sécurité que votre instance Web. Toutes les données sont cryptées pendant leur transit et authentifiées à l’aide d’un « jeton » qui fonctionne comme un mot de passe. L’accès de l’utilisateur à l’API peut être contrôlé en assignant des droits d’accès, tout comme dans d’autres parties de Boréalis, et une date d’expiration peut être ajoutée à un jeton spécifique si vous le souhaitez. Cela garantit que les utilisateurs ne peuvent accéder qu’aux informations qu’ils sont autorisés à voir.

 

Mon organisation devrait-elle utiliser l’API de Boréalis ?

• Avez-vous besoin de saisir des données externes dans Boréalis [et/ou] avez-vous besoin d’envoyer des données de Boréalis vers un autre système ?
• Ajoutez-vous ou modifiez-vous des données au moins une fois par mois [et/ou] devez-vous créer ou mettre à jour un grand nombre de données ?
• La saisie manuelle des données prend-elle beaucoup de temps, et ces données existent-elles potentiellement déjà dans une autre plateforme ?

Si vous avez répondu OUI à une ou plusieurs de ces questions, l’API est peut-être la solution qu’il vous faut !

 

Comment puis-je connecter Boréalis à un autre système ?

Si vous souhaitez configurer l’API de Boréalis, sachez que l’intégration prend deux jours de service. Cela peut prendre plus longtemps si vous avez beaucoup d’exigences personnalisées. 

 

La documentation de notre API permet à votre équipe informatique de connecter facilement Boréalis aux autres systèmes que vous utilisez. La documentation n’est pas disponible par défaut ; vous devrez créer un jeton d’accès afin de la consulter.

 

Créer le jeton d’accès

Voici comment générer le jeton d’accès dont vous avez besoin pour accéder à la documentation (veuillez vous référer à cet article du Centre d’aide pour plus d’informations) :

1. Ouvrez la fiche de l’utilisateur auquel vous souhaitez accorder l’accès.
2. Cliquez sur l’onglet « Jeton d’accès ». (La documentation de l’API n’est pas disponible si aucun jeton n’est actif)
3. Utilisez le bouton vert « + » pour ajouter un jeton. Saisissez simplement un nom pour le jeton, une date d’expiration (facultative), et cliquez sur Enregistrer.

 

Configuration de l’API

Une fois que vous avez accès à la documentation de l’API, voici les étapes que votre organisation doit suivre :

1. Analysez et déterminez les processus d’intégration optimaux.
2. Si des données doivent être envoyées de Boréalis vers un autre système, nous créerons un widget Analytics pour simplifier le transfert de données.
3. Votre équipe informatique (ou l’entrepreneur sélectionné) devra développer le connecteur, et nous communiquerons avec elle pour l’aider à le faire. Il se peut que nous devions apporter des ajustements mineurs à certains points de terminaison de l’API pour simplifier l’intégration.
4. Une fois le développement finalisé, nous pouvons rencontrer à nouveau votre équipe informatique (ou les contractants choisis) pour développer des tests automatisés qui garantiront une connexion robuste à l’avenir.

L’importance d’une bonne configuration

L’importation automatique de données provenant de sources externes peut vous faire gagner beaucoup de temps, mais il est important de se rappeler qu’elle comporte certains risques. Si votre connexion n’est pas configurée correctement, vous pourriez finir par importer ou mettre à jour les mauvaises données dans Boréalis. Avant d’envisager la mise en œuvre de l’API, il est important de s’assurer que vous disposez du soutien et de l’engagement nécessaires de votre équipe informatique.