Documentation API

Authentification

Authentification API

Toutes les demandes API nécessitent une authentification à l'aide d'une clé API. Ce guide explique comment créer, gérer et utiliser les clés API de manière sécurisée.

Obtenir une clé API

Pour obtenir une clé API, vous devez avoir un compte iloveQR et faire partie d'une organisation.

Connectez-vous à votre compte

Connectez-vous ou créez un compte si vous n'en avez pas.

Accédez à la page Développeurs

Allez à Tableau de bord → Développeurs pour gérer vos clés API.

Créer une nouvelle clé API

Cliquez sur 'Créer une clé API', donnez-lui un nom descriptif et conservez en toute sécurité la clé générée.

Utiliser votre clé API

Incluez votre clé API dans l'en-tête X-API-Key avec chaque requête :

En-tête de requête

curl -X GET \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: ilqr_your_api_key_here" \
  -H "Content-Type: application/json"

ID d'organisation

La plupart des points de terminaison API nécessitent un ID d'organisation dans le chemin de l'URL. Vous pouvez trouver votre ID d'organisation dans les paramètres du tableau de bord ou en faisant une requête au point de terminaison des organisations.

Obtenez vos organisations

curl -X GET \
  https://api.iloveqr.com/api/v1/users/me/organizations \
  -H "X-API-Key: ilqr_your_api_key_here"

Réponse

{
  "organizations": [
    {
      "id": "org_abc123",
      "name": "My Company",
      "slug": "my-company",
      "role": "ADMIN"
    }
  ]
}

Meilleures pratiques de sécurité

Ne jamais exposer les clés API dans le code côté client

Faites toujours des appels API depuis votre serveur. N'incluez jamais de clés API dans le JavaScript qui s'exécute dans le navigateur, les applications mobiles ou tout code qui peut être vu par les utilisateurs.

Utilisez des variables d'environnement

Stockez vos clés API dans des variables d'environnement, pas dans votre code. Cela empêche l'exposition accidentelle par le contrôle de version.

Faites tourner les clés régulièrement

Créez de nouvelles clés API périodiquement et révoquez les anciennes. Si vous soupçonnez qu'une clé a été compromise, révoquez-la immédiatement.

Erreurs d'authentification

Lorsque l'authentification échoue, l'API renvoie l'une de ces réponses d'erreur :

Code d'état	Erreur	Description
401	UNAUTHORIZED	Clé API manquante ou invalide
403	FORBIDDEN	La clé API n'a pas la permission pour cette action
403	API_KEY_REVOKED	La clé API a été révoquée

Exemple de réponse d'erreur

{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

Prochaines étapes

Maintenant que vous comprenez l'authentification, apprenez à utiliser l'API :