- Comprendre le fonctionnement d’une API
- Générer une clé d’API Orfeo
- Faire appel à un prestataire spécialisé
- Intégrer en autonomie via des solutions No code
- Demander une prestation d’accompagnement
Comprendre le fonctionnement d’une API
Une API (Application programming interface ou interface de programmation d’application) est une interface qui permet à des logiciels différents de communiquer entre eux et d’échanger des données.
L’API définit la façon dont deux outils distincts communiquent et échangent leurs données. Il s’agit d’une sorte de connecteur entre deux systèmes qui permet d’intégrer de nouvelles fonctionnalités dans un autre outil.
De nombreuses intégrations sont possibles, par exemple :
- Ajouter les dates publiées de vos tournées présentes sur Orfeo sur votre site internet (réalisé sur Wix, Wordpress ou autre)
- Publier un message sur un channel Slack dès qu'un projet est confirmé sur Orfeo
- Envoyer un e-mail récapitulatif aux manageurs des artistes pour résumer les dates confirmées, les montants, etc.
- Synchroniser son annuaire Orfeo avec l'annuaire d'une messagerie (Google contacts, Microsoft 365, etc.)
- Synchroniser son annuaire Orfeo avec l'annuaire d'un outil de newsletter (Brevo, MailChimp, etc.)
Générer une clé d’API Orfeo
Pour générer une clé d'API Orfeo, rendez-vous sur la page Votre Organisation (accessible aux administrateurs).
- cliquez sur le menu API & webhooks
- donnez un nom à la clé
- déterminez les permissions associées
- cliquez sur Ajouter
La clé est générée et vous pouvez la copier.
Bon à savoir Les permissions permettent de moduler l'accès aux données sensibles stockées dans Orfeo via l'API. Il peut s’agit des coordonnées personnelles, des données contractuelles, etc.
Astuce Le nombre de clés d'API est illimité. Il est conseillé de créer une clé par usage. Ainsi, vous pouvez personnaliser les permissions clé par clé en fonction de l’utilisation de la clé avec l’outil tiers. De plus, Le fait de générer une clé par outil tiers permet de révoquer une clé d'API si vous n'utilisez plus un des outils sans impacter le bon fonctionnement des autres intégrations.
Ensuite, il existe deux options pour exploiter les données de l’API. Vous pouvez :
- Faire appel à un prestataire spécialisé
- Exploiter dans l’outil tiers cet accès que l’on met à disposition sur notre base en toute autonomie avec le no-code
Faire appel à un prestataire spécialisé
Si vous ne disposez pas des compétences en informatique nécessaires, vous pouvez faire appel à un prestataire spécialisé.
Vous devez :
- spécifier les contours de l’intégration voulue au prestataire
- lui transmettre la documentation technique sur l’API pour faciliter l’intégration
- lui ouvrir un accès Orfeo en lecture seule pour qu’il puisse visualiser les données à échanger
Si vous le souhaitez nous pouvons mettre à votre disposition une liste de prestataires connaissant Orfeo et pouvant travailler avec vous sur l’utilisation de l’API. Pour cela, écrivez-nous à l’adresse api@orfeo.pro
Intégrer en autonomie via des solutions No code
Il est également possible d’exploiter les données de l’API en toute autonomie à l’aide d’une solution No code. Ces solutions permettent de traduire pour vous vos besoins en langage informatique. Vous pouvez par exemple utiliser la solution Make.
De nombreuses utilisations de l’API sont possibles via les solutions No code.
Pour en savoir plus sur les solutions No code, consultez l’article L’API au service du spectacle vivant : la fin des copiés/collés.
Demander une prestation d’accompagnement
Si vous avez besoin d’être guidé pour exploiter pleinement l’API Orfeo, nous proposons une prestation d’accompagnement à ce sujet. Cette prestation prend la forme d’un atelier d’une heure, organisé à distance. Durant cette formation, nous vous expliquons le fonctionnement de l’API (les requêtes, les filtres, etc.), les données à cibler et le paramétrage de vos clés d’API.
En cas de questions sur l’API ou pour plus en savoir plus sur la prestation d’accompagnement, écrivez-nous à api@orfeo.pro