Clés API
Utilisez une clé API personnelle pour appeler l’API REST depuis vos scripts.
Créer et révoquer une clé
Connectez-vous à NinjaBuy et ouvrez Compte → Parrainages → Clés API pour créer, lister et révoquer des clés nommées. La clé complète commence par nb_ et n’est affichée qu’une seule fois. Utilisez Copier la clé pour la conserver en lieu sûr avant de fermer le message.
Une clé n’expire jamais, sauf si vous choisissez une durée lors de sa création : 30 jours, 90 jours ou 1 an. La révocation ou la fin de cette durée s’applique dès la requête suivante, et une clé expirée disparaît de la liste.
Seule une empreinte SHA-256 de la clé est stockée.
Utiliser une clé
Fournissez votre clé à votre script sous le nom NINJABUY_API_KEY et envoyez-la dans l’en-tête Authorization :
curl -sS https://www.ninjabuy.com/api/v1/links \
-H "Authorization: Bearer $NINJABUY_API_KEY" \
-H "Content-Type: application/json" \
--data '{"links":["https://weidian.com/item.html?itemID=7581746714"]}'Le même en-tête fonctionne sur toutes les routes REST authentifiées : Liens, Recherche, téléversements et Feuilles de calcul, et Tâches. Le document OpenAPI ne nécessite aucune authentification.
Permissions et limites
Chaque clé reçoit les trois permissions. Il n’y a pas de sélecteur de permissions.
| Permission | Routes |
|---|---|
links:create | POST /api/v1/links, POST /api/v1/uploads, POST /api/v1/sheets |
jobs:read | GET /api/v1/jobs/{id} |
search:read | GET /api/v1/search |
Les clés et les requêtes REST OAuth partagent les fenêtres de création et de recherche du compte. La création de liens MCP partage également la fenêtre de création. Consultez Limites de requêtes.
Une clé ne permet pas de se connecter, d’ouvrir une session ni d’appeler MCP ou les API du compte. Utilisez OAuth pour une application agissant pour d’autres clients NinjaBuy ou un client MCP.
Erreurs
Une clé invalide, expirée ou révoquée renvoie le même problème 401 qu’un jeton OAuth invalide. Une indisponibilité du stockage des clés renvoie 503 avec Retry-After. Consultez Erreurs.