Clés API

Les clés API vous permettent d'authentifier les requêtes vers l'API Business d'Oquira sans utiliser de cookies de session. Elles sont idéales pour les intégrations de serveur à serveur.

Créer une Clé API

Générez une nouvelle clé pour votre organisation. Assurez-vous de copier la clé immédiatement, car elle ne sera plus affichée.

POST /v1/organizations/{organizationId}/api-keys
X-API-Key: votre_cle_api
Content-Type: application/json

{
  "name": "Clé d'Intégration Production",
  "permissions": ["read", "write"]
}

Liste des Clés API

Consultez toutes les clés API actives pour votre organisation. Notez que les valeurs complètes des clés sont masquées pour des raisons de sécurité.

GET /v1/organizations/{organizationId}/api-keys
X-API-Key: votre_cle_api

Révoquer une Clé API

Désactivez définitivement une clé API. Toute requête utilisant une clé révoquée entraînera une erreur 401 Unauthorized.

DELETE /v1/organizations/{organizationId}/api-keys/{keyId}
X-API-Key: votre_cle_api

Utilisation

Incluez la clé dans l'en-tête X-API-Key de vos requêtes.

GET /v1/business/dashboard
X-API-Key: oq_abc123...