Qamaq - AI-Powered Teammate for Every Employee

Clés API

L'API Qamaq utilise des clés API pour authentifier les requêtes. Les clés API sont liées à votre organisation et peuvent avoir différents périmètres de permissions pour contrôler les actions qu'elles peuvent effectuer.

Gardez vos clés API en sécurité

Ne partagez jamais vos clés API dans des dépôts publics, du code côté client où d'autres emplacements accessibles publiquement. Traitez-les comme des mots de passe.

Créer des clés API

Pour créer une clé API :

1Connectez-vous à votre tableau de bord Qamaq
2Accédez à Configurations > Clés API
3Cliquez sur « Créer une nouvelle clé API »
4Donnez un nom descriptif à votre clé et sélectionnez les périmètres appropriés
5Copiez et stockez votre clé API en lieu sûr — elle ne sera plus affichée

Utiliser les clés API

Incluez votre clé API dans l'en-tête Authorization en utilisant le schéma Bearer :

cURL

curl -X GET "https://api.qamaq.io/api/v1/me" \
  -H "Authorization: Bearer qmq_your_api_key"

JavaScript

const response = await fetch('https://api.qamaq.io/api/v1/me', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer qmq_your_api_key'
  }
});
const data = await response.json();

Python

import requests

response = requests.get(
    'https://api.qamaq.io/api/v1/me',
    headers={'Authorization': 'Bearer qmq_your_api_key'}
)
data = response.json()

Périmètres des clés API

Les clés API peuvent avoir différents périmètres qui contrôlent les ressources auxquelles elles peuvent accéder :

Scope	Description
`entities:read`	Lire les schémas et enregistrements d'entités
`entities:write`	Créer et modifier les enregistrements d'entités
`knowledge:read`	Lire les dossiers et fichiers de la base de connaissances
`knowledge:write`	Créer et modifier les dossiers et fichiers
`boards:read`	Lire les tableaux et tickets
`boards:write`	Créer et modifier les tableaux et tickets

Erreurs d'authentification

Si l'authentification échoue, vous recevrez l'une de ces réponses d'erreur :

401Unauthorized

Aucune clé API fournie où le format de la clé est invalide.

403Forbidden

La clé API est valide mais ne dispose pas des permissions pour la ressource où l'action demandée.

Bonnes pratiques

Utilisez des variables d'environnement pour stocker les clés API, ne les codez jamais en dur
Créez des clés API distinctes pour différentes applications où environnements
Utilisez les périmètres minimaux requis pour chaque clé API
Effectuez une rotation régulière des clés API pour une meilleure sécurité
Surveillez l'utilisation des clés API dans votre tableau de bord
Révoquez immédiatement toute clé API susceptible d'avoir été compromise

Authentification