Clés API et authentification

L'authentification à l'API externe s'effectue via des clés API (API key), distinctes des identifiants utilisateur. Une clé identifie une organisation et possède des permissions spécifiques.

Générer une clé

1. 1

   Ouvrez le panneau API

   Allez dans Administration → API. Seuls les utilisateurs avec le rôle Owner ou Admin peuvent gérer les clés.

2. 2

   Créez une nouvelle clé

   Attribuez un nom descriptif (ex. 'PMS production', 'Zapier dev') et sélectionnez le niveau de permission.

3. 3

   Copiez immédiatement la valeur

   La clé n'est affichée qu'une seule fois. Conservez-la en lieu sûr : un gestionnaire de mots de passe, un coffre-fort, une variable d'environnement. yourang.ai ne stocke que le hash, il ne pourra pas vous la remontrer.

4. 4

   Configurez le système externe

   Collez la clé dans le système qui devra appeler l'API. L'appel de test confirme que tout fonctionne.

Niveaux de permission

• Read. Lecture seule : contacts, commandes, appels, statistiques. Idéal pour dashboards, rapports, synchronisations en pull.
• Write. Lecture + création/modification de données : ajouter des contacts, enregistrer des commandes, créer des réservations. Pour les intégrations bidirectionnelles.
• Write + appels sortants. Inclut la possibilité de déclencher des appels sortants. C'est la permission la plus puissante, à n'attribuer qu'à des systèmes de confiance.

Utiliser la clé

Chaque requête inclut la clé dans l'en-tête HTTP Authorization sous forme de Bearer token. Exemple : Authorization: Bearer yr_live_abc123. L'API valide la clé, identifie l'organisation et applique les permissions avant de traiter la requête.

Rotation et révocation

Bonne pratique : faites tourner les clés au moins une fois par an ou chaque fois que le personnel qui les gère change. La révocation est immédiate : en cliquant sur 'révoquer', la clé cesse de fonctionner instantanément. Créez toujours une nouvelle clé avant de révoquer l'ancienne, pour éviter les interruptions de service.

Ouvrir le portail développeur

Console API, journaux de requêtes, OpenAPI explorable.

Aller à la vue d’ensemble de l’API

Endpoints REST, authentification, exemples pratiques.