VibeFox Loggi for PrestaShop — Aide

Prérequis

PrestaShop : 8.0 à 9.x.

PHP : 8.0 ou ultérieur. Le module refuse de s'installer sur les anciennes versions de PHP.

Compte Loggi (uniquement pour les prix en temps réel) : le prix en temps réel utilise l'API GraphQL de Loggi avec une clé d'API que Loggi délivre aux comptes professionnels. Adressez-vous à votre responsable de compte Loggi ou au support intégrations de Loggi (integracoes@loggi.com). Voir aussi la documentation de l'API Loggi sur docs.api.loggi.com. Il vous faut trois valeurs : l'e-mail de votre compte Loggi, la clé d'API et l'identifiant numérique de votre boutique. Si votre compte Loggi ne dispose que d'identifiants pour la nouvelle API de la plateforme REST de Loggi (ID client et secret), le prix en temps réel n'est pas disponible et les prix fixes sont utilisés. Si vous n'utilisez que des prix fixes, vous n'avez pas besoin de compte Loggi.

Clé de licence VibeFox : achetée sur vibefox.net. Une clé fonctionne sur un seul domaine.

Installation

1. Dans le back-office, allez dans Modules > Module Manager et cliquez sur Upload a module. Choisissez le fichier ZIP du module.

2. Une fois le téléversement terminé, cliquez sur Configure, ou retrouvez VibeFox Loggi plus tard dans la liste des modules et cliquez sur Configure.

3. Saisissez votre clé de licence VibeFox dans License key, dans le bloc de licence en haut de la page Configure, puis cliquez sur Activate (voir Clé de licence).

4. Saisissez l'e-mail de l'API Loggi, la clé d'API, le Shop ID et l'adresse d'enlèvement et, si la devise par défaut de votre boutique n'est pas le BRL, le taux de change BRL. Ajoutez des prix fixes en filet de sécurité (voir Configuration) et cliquez sur Save.

5. Ajoutez le Brésil aux zones du transporteur Loggi dans Shipping > Carriers, ou activez Ignore shipping zones et choisissez des pays.

À l'installation, le module crée le transporteur Loggi avec le texte de délai de livraison Courier delivery in Brazil. Le transporteur est affecté à toutes les zones et à tous les groupes de clients. Vous pouvez modifier les zones, les groupes de clients, le délai de livraison, le logo et les limites de taille dans Shipping > Carriers. N'y définissez pas de prix : le prix provient toujours du module.

Configuration

Tous les réglages se trouvent sur la page du module : Modules > Module Manager > VibeFox Loggi > Configure. Ils s'appliquent à toutes les zones du transporteur. Chaque section a son propre bouton Save, qui enregistre la page entière. Chaque enregistrement vide aussi le cache des prix Loggi.

Les avertissements en haut de la page signalent une configuration incomplète : pas d'identifiants d'API (seuls les prix fixes sont utilisés), pas d'identifiants d'API ni de prix fixes (le transporteur n'est jamais affiché), pas d'adresse d'enlèvement, pas de taux de change BRL, ou une unité de poids ou de dimension de la boutique que le module ne reconnaît pas (il la compte alors en kg ou en cm ; réglez les unités dans International > Localization). Si une valeur est invalide, par exemple un nombre négatif, la page affiche une erreur et rien n'est enregistré.

Général

Enable Loggi: active ou désactive le transporteur. C'est le même interrupteur que le statut du transporteur dans Shipping > Carriers.

Method title: le nom du transporteur affiché au client dans le panier et lors du paiement. Par défaut : Loggi. Obligatoire, 64 caractères maximum.

API Loggi (prix en temps réel) (laissez les identifiants vides pour utiliser uniquement les prix fixes)

API e-mail: l'e-mail de votre compte Loggi. La clé d'API lui est rattachée. Il doit s'agir d'une adresse e-mail valide.

API key: votre clé d'API Loggi. Elle est envoyée uniquement à Loggi et n'est jamais journalisée. Après l'enregistrement, le champ reste vide et affiche Saved — leave empty to keep it; clear the API e-mail to remove it. Ne saisissez une nouvelle valeur que pour la modifier. Si vous changez API e-mail, saisissez aussi la clé d'API correspondant au nouvel e-mail, sinon la page affiche une erreur et rien n'est enregistré. Pour supprimer la clé enregistrée, videz API e-mail et enregistrez.

Shop ID: l'identifiant numérique (pk) de votre boutique dans le tableau de bord Loggi. Seul un nombre positif est accepté. Une autre valeur est refusée avec une erreur.

Staging: utilise l'environnement de staging de Loggi avec des identifiants de test. Le staging et la production ont des comptes et des clés différents. Par défaut : désactivé.

Pickup address: l'adresse où Loggi récupère les colis, sur une seule ligne : numéro et rue, quartier, ville, État et CEP, par exemple Rua Example, 123 - Bairro, São Paulo - SP, 01310-100. Laissez vide pour utiliser l'adresse de la boutique de Shop Parameters > Contact > Stores si elle est au Brésil et possède une adresse et une ville. Sans adresse d'enlèvement, Loggi ne peut pas estimer et seuls les prix fixes sont utilisés.

BRL exchange rate: les prix Loggi sont en reals brésiliens. Si la devise par défaut de votre boutique est le BRL, ce champ n'est pas nécessaire et la page l'indique. Sinon, saisissez combien vaut 1 BRL dans la devise de votre boutique, par exemple 0.16. Sans lui, les prix en temps réel ne sont pas utilisés. Seul un nombre positif est accepté. Le point et la virgule sont tous deux acceptés comme séparateur décimal.

Prix fixes (dans la devise par défaut de votre boutique, hors taxes)

Les prix fixes sont utilisés lorsque l'API Loggi n'est pas configurée, pour les destinations hors du Brésil ou sans CEP complet, et chaque fois que Loggi ne renvoie pas de prix (API indisponible, clé refusée, adresse hors zone de couverture).

Price table: une ligne par pays de destination. Cliquez sur Add country pour ajouter une ligne et sur l'icône corbeille pour en supprimer une. Choisissez * All other countries pour tous les pays sans ligne propre. Chaque ligne contient un Base price et des colonnes de poids : XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg et XL >5 kg. Une colonne de poids vide (ou à 0) utilise le prix de base. Un prix de base de 0 signifie livraison gratuite. « 9.99 » et « 9,99 » sont acceptés. Les lignes vides et une seconde ligne pour le même pays sont supprimées à l'enregistrement.

Price for countries not in the table: utilisé lorsqu'il n'existe pas de prix Loggi en temps réel et que la grille ne contient pas de ligne pour le pays de destination (ni de ligne *). Laissez vide pour masquer le transporteur dans ce cas.

Fixed price applies: la manière dont les prix fixes sont calculés. Un prix Loggi en temps réel couvre déjà tout le panier et n'est jamais multiplié.

Conditions

Minimum weight: masque le transporteur lorsque le panier pèse moins, en kg. 0 signifie sans limite.

Maximum weight: masque le transporteur lorsque le panier pèse plus, en kg. Par défaut : 30. 0 signifie sans limite. Minimum weight ne peut pas être supérieur à Maximum weight.

Minimum order amount: n'affiche le transporteur que si le sous-total du panier (après remises, avant taxes) atteint ce montant. Laissez vide pour l'afficher toujours.

Free shipping from: le sous-total du panier (après remises, avant taxes) à partir duquel la livraison Loggi est gratuite. Laissez vide pour aucune livraison gratuite.

Tax: la règle de taxe du transporteur, ou No tax. Choisissez No tax si vos prix et le prix Loggi incluent déjà les taxes.

Pour les limites de poids et les colonnes de poids, un produit sans poids compte pour 0 kg.

Disponibilité sans zones de livraison

Ignore shipping zones: propose Loggi pour les pays indiqués ci-dessous, quelle que soit la zone correspondante. Si vous enregistrez avec cette option activée, le transporteur est ajouté à toutes les zones, ainsi qu'aux zones créées plus tard. La désactiver supprime ces zones ajoutées afin que le transporteur retrouve ses propres zones.

Countries: les pays de destination pour ce mode. Laissez vide pour autoriser tous les pays actifs de votre boutique. Ce champ n'est utilisé que si Ignore shipping zones est activé.

Avancé

Debug log: écrit les calculs de prix et les requêtes Loggi dans logs/vfd_lggi_debug.log.php, dans le dossier du module. Le fichier ne peut pas être ouvert depuis le web. Les erreurs de l'API sont toujours journalisées, même si cette option est désactivée. La clé d'API et les adresses des clients ne sont jamais journalisées.

Log: affiche la taille et les dernières entrées du journal de débogage. Cliquez sur Clear log pour le vider.

Remove data on uninstall: si activé, la désinstallation du module supprime les réglages Loggi, le transporteur, les prix en cache et les journaux. Si désactivé, tout est conservé pour une réinstallation.

Fonctionnement au moment du paiement

À l'étape de livraison, PrestaShop demande au module le prix Loggi. Seuls les produits physiques comptent : les produits virtuels n'ajoutent aucun poids et ne sont pas inclus dans le montant de la commande. Le module vérifie d'abord les conditions : pays autorisés (avec Ignore shipping zones), poids du panier et montant minimum de commande. Si la livraison gratuite s'applique, le prix est de 0 et aucune requête n'est envoyée à Loggi.

Pour une adresse au Brésil avec un CEP complet à 8 chiffres, le module crée des colis Loggi : chaque article est tourné de sorte que son plus petit côté soit la hauteur, et les articles sont empilés dans un même colis tant qu'il reste dans 55 × 55 × 55 cm et 20 kg. Les produits sans poids ni dimensions comptent pour 1 cm par côté, et chaque colis pèse au moins 100 g. Loggi accepte 2 colis par estimation : les paniers plus volumineux sont donc envoyés en plusieurs requêtes et les totaux sont additionnés. Le module envoie à Loggi votre Shop ID, l'adresse d'enlèvement, l'adresse de livraison et les colis, et convertit le total Loggi de BRL vers la devise par défaut de votre boutique. Le prix est ensuite affiché dans la devise du panier du client.

Chaque prix Loggi est mis en cache pendant 1 heure par panier, adresse, compte et environnement, afin que le même panier ne déclenche pas une nouvelle requête. Une estimation échouée est mise en cache pendant 10 minutes. Si Loggi est totalement injoignable, les requêtes sont suspendues pendant 2 minutes, pour que le paiement n'attende pas Loggi à chaque actualisation. Le délai d'expiration de l'API est de 10 secondes.

Les prix fixes sont utilisés à la place lorsque l'API n'est pas configurée, que l'adresse est hors du Brésil ou n'a pas encore de CEP complet, que le taux de change BRL manque, qu'il n'y a pas d'adresse d'enlèvement, qu'un produit est plus grand qu'un colis Loggi, que le panier nécessite plus de 10 colis, ou que Loggi renvoie une erreur, un colis refusé, une adresse hors zone de couverture ou un total nul. S'il n'existe pas non plus de prix fixe, le transporteur est masqué. Le client ne voit jamais d'erreur de l'API. La raison est écrite dans le journal de débogage.

Si vous modifiez le transporteur dans Shipping > Carriers après qu'il a reçu des commandes, PrestaShop l'enregistre comme une nouvelle version du transporteur. Le module suit automatiquement la nouvelle version.

Le module calcule uniquement les prix. Il ne crée pas de commandes ni d'expéditions Loggi, n'imprime pas d'étiquettes, ne suit pas les colis, n'affiche pas le délai de livraison au paiement et ne propose pas de points de retrait ou de casiers. Créez les expéditions dans le tableau de bord Loggi. Loggi livre uniquement au Brésil. Utilisez les prix fixes pour les autres pays.

Clé de licence

Le module fonctionne avec une clé de licence VibeFox obtenue sur vibefox.net. Le bloc de licence License — VibeFox Loggi est le premier bloc de Modules > Module Manager > VibeFox Loggi > Configure, au-dessus des réglages. Saisissez la clé dans License key et cliquez sur Activate. Ensuite, le bloc affiche la clé masquée, le statut (par exemple la date jusqu'à laquelle la licence est active et votre domaine) ainsi que les boutons Check now pour vérifier à nouveau le statut, Change key pour saisir une autre clé et Remove key pour retirer la clé de cette boutique. En dessous figurent la ligne Product: presta-shipping-loggi et le lien Manage licenses and domains in your account, qui ouvre votre compte vibefox.net. Seuls les employés disposant de l'autorisation Configure pour le module peuvent modifier la clé. Les textes du bloc suivent la langue du back office (l'anglais et le russe sont inclus).

Si la clé n'est pas acceptée, le bloc indique la raison, par exemple Key not found, This key belongs to another product, Domain limit reached ou License expired on suivi d'une date. Après un changement d'adresse de la boutique, ou après avoir libéré un emplacement de domaine dans votre compte, cliquez sur Check now. Si le serveur de licences est injoignable, le module continue de fonctionner avec le dernier statut connu.

Une clé fonctionne sur un seul domaine : celui de la boutique principale, y compris dans une configuration multiboutique. Retirer la clé de la boutique ne libère pas son emplacement de domaine. Libérez-le dans votre compte vibefox.net.

Sans clé active, le transporteur Loggi n'est pas proposé aux clients au moment du paiement et aucun tarif n'est calculé. La vitrine de PrestaShop ne sait pas que vous êtes connecté au back office : le transporteur est donc masqué pour vous aussi. Vous pouvez configurer le module avant d'acheter une clé, mais pas le tester au moment du paiement. Un rappel apparaît dans Modules > Module Manager, sur l'onglet Alerts. Les commandes existantes ne sont pas affectées.

Lorsqu'une licence expire, le module continue de fonctionner, mais les mises à jour et le support nécessitent un renouvellement. Le statut est vérifié à nouveau automatiquement pendant votre travail dans le back office : une fois par jour pendant les 14 premiers jours suivant la saisie de la clé, puis une fois par semaine. Aucune tâche cron n'est nécessaire. La désinstallation ou la réinitialisation du module supprime toujours la clé de licence et le statut de la licence.

Dépannage

Loggi n'apparaît pas au paiement : vérifiez que la licence est active et que Enable Loggi est activé. Dans Shipping > Carriers, vérifiez que le transporteur couvre la zone du pays du client et son groupe de clients (ou que Ignore shipping zones est activé et que le pays est autorisé). Consultez les avertissements en haut de la page du module, les limites de poids et Minimum order amount. Si le client n'a pas encore saisi de CEP complet ou si Loggi ne renvoie aucun prix, le transporteur a besoin d'un prix fixe : une ligne pour le pays, une ligne * ou Price for countries not in the table. Des produits peuvent aussi être limités à certains transporteurs dans la fiche produit.

Seuls les prix fixes s'affichent : consultez le champ Log sur la page du module. Les erreurs sont toujours journalisées. Activez Debug log pour chaque étape et rechargez le paiement. Causes fréquentes : e-mail, clé ou Shop ID de l'API manquant, pas d'adresse d'enlèvement, pas de BRL exchange rate pour une devise de boutique autre que le BRL, pas encore de CEP complet à 8 chiffres, produit plus grand que 55 cm ou plus lourd que 20 kg, ou adresse hors de la couverture Loggi.

HTTP 401 ou 403 dans le journal : Loggi a refusé l'e-mail ou la clé de l'API. Vérifiez-les auprès de Loggi et contrôlez que Staging correspond aux identifiants : les clés de staging et de production sont différentes.

Ma boutique vend en euros ou en dollars : Loggi répond en BRL. Saisissez le BRL exchange rate (combien vaut 1 BRL dans la devise par défaut de votre boutique). Les prix fixes sont toujours exprimés dans la devise par défaut de votre boutique.

Les prix ne sont pas exacts : renseignez le poids et les dimensions de vos produits. Sans eux, les produits comptent pour 1 cm par côté et chaque colis pour au moins 100 g.

Per item ne multiplie pas le prix Loggi : c'est voulu. Un prix Loggi en temps réel couvre tout le panier. Per item ne s'applique qu'aux prix fixes.

Les prix semblent périmés après une modification : cliquez sur Save sur la page du module. Cela vide le cache des prix Loggi.

La page indique que le transporteur Loggi est introuvable : le transporteur a été supprimé dans Shipping > Carriers. Réinitialisez le module dans Modules > Module Manager pour le recréer.

Désinstallation

Allez dans Modules > Module Manager, ouvrez le menu à côté de VibeFox Loggi et choisissez Uninstall. La clé de licence et le statut de la licence sont toujours supprimés. Le cache des prix Loggi est toujours supprimé. Si Remove data on uninstall est activé, le transporteur est supprimé (les commandes conservent leur historique) et les réglages et le journal sont effacés. S'il est désactivé, le transporteur est seulement désactivé et tous les réglages sont conservés. Réinstaller le module rend au transporteur conservé le statut qu'il avait avant la désinstallation.

Loggi est une marque de son propriétaire respectif. Ce module n'est ni affilié à Loggi ni approuvé par Loggi.