Passer au contenu principal

​
Authentification par clé API

Toutes les requêtes API doivent inclure une clé API dans leurs en-têtes. Les clés API sont transmises dans l’en-tête x-api-key.

​
Création de clés API

Vous pouvez créer et gérer les clés API depuis le tableau de bord de votre organisation.

Gérer les clés API

Créez, consultez et gérez les clés API dans les paramètres de votre organisation

​
Périmètre des clés API

Les clés API appartiennent à une organisation et peuvent être limitées à certains sites web de cette organisation. Vous disposez ainsi d’un contrôle précis des accès lorsque vous gérez plusieurs sites web au sein d’une même organisation.
  • Chaque clé API est associée à une organisation
  • Une organisation peut contenir plusieurs sites web
  • Une clé API peut être limitée à un ou plusieurs sites web précis
  • Les clés API à périmètre limité n’accèdent qu’aux données des sites qui leur sont attribués

​
Clés globales et clés à périmètre limité

Une clé globale couvre toute l’organisation ; une clé à périmètre limité ne couvre que les sites web qui lui sont attribués. Certains points de terminaison concernant toute l’organisation exigent une clé globale et refusent les clés à périmètre limité avec 403 Forbidden: global API key required :
  • Gestion des rôles — tous les points de terminaison /api/v1/roles
  • Membres de l’organisation — /api/v1/organizations/members/{user_id} (modification/suppression)
  • Groupes — gestion de /api/v1/groups et des membres des groupes
  • Invitations à l’organisation et aux groupes — POST /api/v1/invites avec type: "organization" ou type: "group" (les invitations à un site fonctionnent aussi avec une clé à périmètre limité qui inclut le site cible)
Les clés globales équivalent à un accès administrateur — seul un administrateur ou propriétaire de l’organisation peut en créer une. Ces points de terminaison imposent donc le même niveau d’accès administrateur que le tableau de bord.
Seuls les administrateurs de l’organisation peuvent créer, modifier ou supprimer des clés API. Vérifiez que vous disposez des autorisations nécessaires avant de gérer les clés API.