Clés API : connecter une application à votre boutique

Une clé API permet à une application ou à un service (un chatbot qui prend des commandes, votre propre système d'entrepôt, un outil d'automatisation) de lire et de modifier votre boutique via l'API Ordexs. Vous les trouvez dans Paramètres → Développeurs → Clés API.

Qui peut les gérer. Le propriétaire de la boutique et les administrateurs. Les autres membres de l'équipe qui ont accès aux paramètres peuvent voir la liste, mais pas créer ni révoquer de clés.

Forfaits. Les clés API sont incluses dans les forfaits Starter, Growth et Scale : 3, 10 et 25 clés actives. Sur Try, les clés existantes sont mises en pause (pas supprimées) et refonctionnent dès que la boutique passe à un forfait supérieur.

Créer une clé. Appuyez sur Créer une clé, donnez-lui un nom que vous reconnaîtrez, choisissez Réel ou Test, puis ses permissions. Des raccourcis sont proposés : Lecture seule, App de commandes et Accès complet ; vous pouvez aussi cocher les permissions une par une (voir les produits et le stock, modifier les commandes, voir les clients, voir les expéditions, envoyer au transporteur, assigner les commandes, voir le détail du stock, gérer le stock, voir ou gérer les offres et réductions, voir les encaissements et versements, enregistrer les versements des transporteurs, gérer les webhooks, etc.). « Gérer le stock » permet à une application d'ajouter ou de retirer du stock avec un motif, d'enregistrer des réceptions et de lancer des inventaires ; ses modifications apparaissent dans l'historique du stock sous le nom de la clé. « Voir les prix de revient » est désactivé sauf si vous l'activez.

Envoyer au transporteur. Une clé dotée de cette permission peut envoyer vos commandes à votre transporteur et annuler les colis qu'il n'a pas encore ramassés, exactement comme le bouton Envoyer au transporteur : même choix de transporteur (celui choisi au paiement, sinon vos règles de routage, sinon votre transporteur par défaut), mêmes vérifications. Chaque envoi depuis une clé réelle crée un vrai colis chez votre transporteur. Les commandes dont l'adresse attend encore d'être vérifiée ne peuvent pas être envoyées. Une clé de test n'atteint jamais un transporteur : ses colis sont simulés.

Offres et réductions. « Gérer les offres et réductions » permet à une application de créer, modifier, mettre en pause et supprimer vos lots, packs de quantité, ventes croisées et codes promo, comme sur les pages Offres et Remises, avec les mêmes limites (30 offres, 50 remises). « Voir les offres et réductions » ne fait que les lire avec leurs résultats, et vérifie si un code fonctionne.

Modifier des commandes déjà envoyées. Une application qui peut modifier les commandes peut aussi corriger une commande dont le colis est déjà chez le transporteur, comme lorsque vous enregistrez la fiche de commande : la modification part d'abord chez le transporteur et n'est enregistrée que s'il l'accepte, pour les informations que ce transporteur permet de changer, jusqu'à ce que le colis soit validé ou ramassé.

Traitements en masse. Une application peut envoyer des milliers de commandes, de modifications de produits ou de modifications de stock d'un coup (jusqu'à 10 000 lignes par traitement). Ordexs les traite en arrière-plan, chacune exactement comme si elle avait été envoyée seule, et indique à l'application quelles lignes ont échoué et pourquoi. Une boutique exécute 3 traitements à la fois. Une application qui peut lire les commandes peut aussi toutes les télécharger dans un seul fichier d'export.

Pixels marketing. « Gérer les pixels marketing » permet à une application d'ajouter, de modifier ou de supprimer vos pixels Meta, TikTok, Google et autres, comme dans Intégrations → Pixels. Le jeton de l'API Conversions n'est jamais partagé avec les applications : vous l'ajoutez dans le tableau de bord.

Contenu de la boutique. « Gérer le contenu de la boutique » permet à une application de modifier les informations de votre boutique (nom, contact, adresse, langue de la boutique, fuseau horaire, préfixe des numéros de commande), vos politiques, vos pages de contenu ainsi que les champs et boutons de votre formulaire de commande. Les pages de destination peuvent être publiées, renommées, dupliquées ou supprimées, mais leur design reste dans le créateur de pages.

Statistiques. « Voir les statistiques » permet à une application de lire les mêmes chiffres que l'Aperçu (commandes, chiffre d'affaires, visites, vos encaissements, transporteurs, meilleures ventes, régions), les analyses clients et les performances de l'équipe. Elle ne peut rien modifier.

Configuration de la livraison. « Gérer la configuration de la livraison » permet à une application de modifier vos tarifs de livraison par wilaya, la stratégie de tarification (vos propres tarifs, le client choisit un transporteur, ou le transporteur le moins cher), d'activer ou désactiver la livraison à domicile et le stop desk, de changer le transporteur par défaut et les règles de routage, comme sur la page Livraison. La connexion d'un compte transporteur (ses clés) se fait toujours uniquement dans le tableau de bord.

Images produit. Une clé qui peut modifier les produits peut aussi ajouter des images produit : depuis une adresse web ou un fichier envoyé par l'application. Ordexs génère les mêmes tailles que le tableau de bord et place le fichier dans votre médiathèque, où il compte dans votre stockage comme tout autre envoi. Une application peut ajouter au maximum 500 images par jour et par boutique, et un produit contient 50 images au maximum.

Retours et encaissements. Avec « Gérer le stock », une application peut marquer les colis retournés comme arrivés et les réceptionner (remis en stock ou passés en perte avec un motif), comme dans la fenêtre Retours ; les transporteurs de la famille Ecotrack sont informés du retour du colis, comme depuis le tableau de bord. « Voir les encaissements et versements » lit ce que chaque transporteur doit pour les commandes livrées et ses versements ; « Enregistrer les versements » enregistre l'argent remis par un transporteur (et supprime un versement, ce qui remet ses commandes en attente de paiement), comme Vos encaissements dans l'Aperçu.

La clé n'est affichée qu'une fois. Après sa création, Ordexs affiche la clé complète une seule fois. Copiez-la immédiatement dans votre application. Ordexs n'en conserve qu'une empreinte et ne peut donc plus l'afficher. Si elle est perdue, créez une nouvelle clé et révoquez l'ancienne.

Clés réelles et clés de test. Une clé réelle agit sur vos vraies commandes, vos vrais produits et vos vrais clients. Une clé de test agit sur une boutique de test séparée, pour essayer une application sans risque ; voir l'article sur le mode test.

Révoquer. Appuyez sur le bouton de révocation d'une clé et confirmez. Les applications qui l'utilisent cessent de fonctionner en 30 secondes environ. La révocation est définitive.

Ce qu'affiche la liste. Le nom de chaque clé, si elle est réelle ou de test, son nombre de permissions, sa dernière utilisation et la personne qui l'a créée. Les modifications faites par une application apparaissent sur les commandes comme faites par Clé API « <son nom> ».

À quelle vitesse une application peut aller. Le nombre de requêtes par minute dépend du forfait : 120 sur Starter, 300 sur Growth, 900 sur Scale. Les clés de test ont droit à 60 (120 sur Scale).

Les développeurs trouvent tout ce dont ils ont besoin sur ordexs.com/docs, lien disponible en haut de la page Développeurs.

Plus dans Développeurs

Besoin d'aide supplémentaire ?

Posez votre question à l'assistant depuis la barre de recherche de votre tableau de bord. Il répond à partir de ces mêmes guides, en français, en anglais ou en arabe, et peut effectuer des modifications pour vous. Vous pouvez aussi nous écrire : une personne vous répondra.