Passer au contenu principal
L’API GetQR est en version bêta et réservée à certains espaces de travail. Certains détails peuvent changer avant la disponibilité générale.
L’API GetQR authentifie chaque requête avec la clé API de votre compte. Chaque utilisateur a une seule clé, qui agit en votre nom dans un espace de travail.

​
Avant de commencer

  • Vous êtes le propriétaire de l’espace de travail ou un Editor. Les Viewers ne peuvent ni créer ni utiliser de clé API.
  • Le propriétaire de l’espace de travail a un abonnement actif.

​
Créer votre clé API

1

Ouvrez les paramètres de votre compte

Ouvrez les paramètres de votre compte et allez dans API.
2

Générez la clé

Cliquez sur Generate API key.
3

Copiez la clé

Affichez la clé et copiez-la. Les clés commencent par sk_live_.
Vous pouvez afficher et copier la clé à nouveau à tout moment. Les paramètres indiquent aussi la date de création de la clé et sa dernière utilisation.

​
Authentifier les requêtes

Envoyez la clé en tant que Bearer token dans l’en-tête Authorization de chaque requête :
La vérification de l’état est le seul endpoint qui fonctionne sans clé.

​
Accès et rôles

  • Rôles. Seuls le propriétaire de l’espace de travail et les Editors peuvent créer et utiliser une clé API. Les Viewers ne le peuvent pas.
  • Espace de travail. Chaque clé appartient à un seul espace de travail, et toutes les requêtes s’exécutent dans cet espace. Inutile de transmettre un identifiant d’espace de travail.
  • Vérifications en direct. L’accès est vérifié à chaque requête, selon votre rôle actuel et l’abonnement du propriétaire de l’espace de travail. Votre propre abonnement n’entre pas en compte. Si votre rôle passe à Viewer ou si l’abonnement du propriétaire prend fin, les requêtes renvoient 403 jusqu’au rétablissement de l’accès. Vous n’avez pas besoin d’une nouvelle clé.
  • Retrait. Si vous êtes retiré de l’espace de travail, votre clé API est supprimée. Si vous y êtes ajouté à nouveau, générez une nouvelle clé.

​
Régénérer votre clé

Régénérez la clé si elle a fuité ou si une personne qui ne devrait pas l’avoir y a accès.
Votre clé actuelle cesse immédiatement de fonctionner. Toute application ou intégration qui l’utilise ne fonctionne plus tant que vous ne l’avez pas mise à jour avec la nouvelle clé.
1

Cliquez sur Regenerate

Dans les paramètres de votre compte, allez dans API et cliquez sur Regenerate.
2

Confirmez

Cliquez sur Regenerate key.
3

Mettez à jour vos applications

Copiez la nouvelle clé et remplacez l’ancienne partout où vous l’utilisez.

​
Protéger votre clé

Traitez la clé comme un mot de passe : quiconque la possède peut créer, modifier et supprimer des QR codes dans votre espace de travail.
  • Stockez-la dans une variable d’environnement ou un gestionnaire de secrets, pas dans le code source.
  • N’appelez l’API que depuis votre serveur. Ne placez jamais la clé dans un site web, une application mobile ou tout autre élément que les utilisateurs peuvent inspecter.
  • Ne la partagez qu’avec les développeurs qui en ont besoin.
  • Régénérez-la dès que vous soupçonnez une fuite.

​
Problèmes courants

La clé a été régénérée, ou vous avez été retiré de l’espace de travail et la clé a été supprimée. Copiez la clé actuelle depuis les paramètres de votre compte ou générez-en une nouvelle.
Vérifiez que votre rôle est propriétaire ou Editor, et que l’abonnement du propriétaire de l’espace de travail est actif. La clé fonctionne à nouveau dès que l’accès est rétabli.
L’API est en version bêta et n’est pas encore activée pour votre espace de travail.
Ils n’apparaissent que pour le propriétaire de l’espace de travail et les Editors, et seulement dans les espaces de travail où l’API est activée.

​
Et ensuite

Introduction à l'API

Erreurs