Restreindre une clé API (Accès API)
Chaque canal de vente a sa propre clé API. Avec le bloc Accès API, vous choisissez quelles parties de l'API QrX cette clé peut utiliser, par exemple lorsqu'un partenaire ou un système externe doit seulement lire le stock.
Où le trouver
Allez dans Settings > Business > Merchant Channels, ouvrez le canal de vente et choisissez l'onglet Settings. Le bloc Accès API se trouve sous la clé API. Il vous faut la permission Gérer les canaux pour le modifier ; les autres utilisateurs peuvent seulement le voir.
Accès complet et restreint
Accès complet : la clé peut utiliser chaque partie de l'API QrX, y compris celles que QrX ajoute plus tard. Chaque clé commence ainsi. L'exception est le CRM : un appel CRM n'est accepté que si la partie CRM est cochée ; pour utiliser l'API CRM, vous restreignez donc la clé et vous la cochez (voir ci-dessous).
Restreint : la clé ne fonctionne que pour les parties que vous avez cochées. Un appel à une autre partie est refusé avec une erreur 403.
Les parties que vous pouvez cocher
Retours: Lire les retours (
returns.read), Créer et modifier des retours (returns.write), Enregistrer les retours reçus (returns.receiving.write), Décider de la résolution d'un retour (returns.resolutions.write), Envoyer des messages sur un retour (returns.messages.write), Gérer les webhooks de retours (returns.webhooks.manage).Entrées: Lire les livraisons entrantes et les réceptions (
inbound.read), Annoncer, réceptionner et modifier les livraisons entrantes et les réceptions (inbound.write).Stock: Lire les niveaux de stock, les articles, les emplacements, les mouvements, les inventaires et les conteneurs (
stock.read), Ajuster le stock et créer ou modifier des articles et des emplacements (stock.write).Achats: Lire les commandes fournisseur et leurs prix (
purchasing.read), Créer, envoyer et clôturer des commandes fournisseur (purchasing.write).Traitement: Lire les listes de prélèvement (
fulfilment.read).Tâches: Lire les tâches d'équipe (
tasks.read).CRM: Lire les personnes, entreprises, affaires et pipelines du CRM (
crm.read), Créer et modifier les personnes, entreprises, affaires et notes du CRM (crm.write). Les endpoints CRM des tâches et des activités utilisent la partie lecture.
La restriction couvre ces parties de l'API pour les retours, les arrivages, le stock et le CRM. Créer des transactions, des étiquettes et des produits avec la clé ne figure pas dans la liste et continue de fonctionner.
Restreindre une clé
Activez Restreindre cette clé.
Cochez les parties que la clé peut utiliser. Cochez-en au moins une.
Cliquez sur Enregistrer l'accès API. Le bloc s'enregistre à part.
QrX demande Restreindre cette clé API ? et liste sous Cesse de fonctionner ce que la clé ne peut plus faire. Vérifiez la liste et cliquez sur Restreindre la clé.
Attention : chaque partie qui n'est pas cochée cesse de fonctionner immédiatement, y compris pour les intégrations qui fonctionnent aujourd'hui. Une intégration de retours ou d'arrivages qui utilisait cette clé sans restriction reçoit une erreur dès que sa partie n'est pas cochée. Les parties que QrX ajoute plus tard sont désactivées pour une clé restreinte jusqu'à ce que vous les cochiez.
Le délai de 30 secondes
Une modification peut prendre jusqu'à 30 secondes pour s'appliquer. Pendant ce temps, un appel peut encore être accepté ou refusé selon l'ancien réglage. Attendez une demi-minute avant de tester.
Revenir à l'accès complet
Désactivez Restreindre cette clé et cliquez sur Enregistrer l'accès API. La clé affiche de nouveau Accès complet.
Questions fréquentes
Mon intégration reçoit soudain une erreur 403. Que s'est-il passé ?
Quelqu'un a restreint la clé et la partie que votre intégration utilise n'est pas cochée. Pour le stock, le code d'erreur est STOCK_SCOPE_MISSING. Cochez la partie, enregistrez et attendez 30 secondes.
Un appel CRM reçoit une erreur 403 avec le code CRM_SCOPE_MISSING. Que faire ?
La partie CRM n'est pas cochée sur la clé. Activez Restreindre cette clé, cochez CRM (lecture, écriture ou les deux), enregistrez et attendez 30 secondes. Voir « API publique du CRM ».
La restriction change-t-elle la clé elle-même ?
Non. La clé et ses jetons d'accès restent les mêmes ; seul ce que la clé peut faire change. Pour remplacer la clé elle-même, utilisez Regenerate API Key. Voir "Webhooks et clés API dans PortalX".
Quand contacter notre équipe support
Contactez le support QrX lorsqu'une partie cochée est toujours refusée plus d'une minute après l'enregistrement. Indiquez le canal de vente, l'endpoint et l'heure, jamais la clé ni le jeton.