Authentification et clés API
Créer une clé
Section intitulée « Créer une clé »Créez une clé API sk_ dans le centre API . La clé complète n’est affichée qu’une seule fois, lors de sa création ou de sa rotation.
Utilisez une clé distincte pour chaque application, environnement et tâche automatisée, afin que chacun puisse disposer de son propre budget et être désactivé, rotatif et audité indépendamment.
Envoyez les informations d’identification
Section intitulée « Envoyez les informations d’identification »Recommandé :
X-API-Key: sk_your_keyLa forme standard Bearer fonctionne également :
Authorization: Bearer sk_your_keyN’envoyez qu’un seul des deux dans une requête.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"Ce que représente une clé
Section intitulée « Ce que représente une clé »Une clé sert le compte qui l’a créée : elle peut appeler les services que ce compte est autorisé à utiliser et n’a accès qu’aux ressources de ce compte. Une clé ne peut pas modifier l’adresse e-mail de connexion, le mot de passe, le numéro de téléphone ni le profil, et elle ne peut pas créer, faire pivoter ou révoquer de clés API.
Limites optionnelles :
allowed_engines: uniquement les paramètres de traduction répertoriés ; un tableau vide n’ajoute aucune limite au niveau des clés.expires_at: heure d’expiration.quota_limit: le budget de durée de vie de la clé en millicrédits entiers ;0ne définit aucun budget au niveau de la clé, et les crédits du compte sont réglés comme d’habitude.
Rotation et révocation
Section intitulée « Rotation et révocation »Créez des clés, modifiez leurs limites, effectuez leur rotation ou révoquez-les dans le centre API . Une fois qu’une clé est révoquée, désactivée ou expirée, ou que son compte est désactivé, les nouvelles requêtes échouent immédiatement.
La rotation crée un nouveau secret et désactive immédiatement l’ancien ; la nouvelle clé conserve les limites d’origine ainsi que le budget déjà consommé. Une clé expirée ne peut pas être tournée ; il faut en créer une nouvelle. Pour effectuer la transition en douceur, créez une nouvelle clé et déployez-la, vérifiez que les appels réussissent, puis révoquez l’ancienne clé.
Sécurité
Section intitulée « Sécurité »- Conservez les clés uniquement sur le serveur ou dans un environnement d’exécution contrôlé.
- Utilisez des variables d’environnement ou un gestionnaire de secrets ; ne placez jamais les clés dans le code source, les journaux, les bundles navigateur ou les dépôts publics.
- N’envoyez jamais la clé aux adresses de téléchargement ou de téléversement renvoyées par l’API.
- Enregistrez l’ID de clé, l’ID de requête et l’ID d’opération ; n’enregistrez jamais la clé complète.
- Si une clé est compromise, effectuez immédiatement une rotation et réexaminez ses tâches et ses charges.