Guide du module Passerelle de paiement Adyen pour LaraClassifier & JobClass

Prérequis

• Créez un compte Adyen sur https://www.adyen.com
• Chaque requête API que vous envoyez à Adyen est traitée via un identifiant API lié à votre compte entreprise. Pour qu'une requête API aboutisse, vous devez :
  • Générer une clé API (l'add-on s'authentifie uniquement par clé API : l'authentification basique n'est pas prise en charge).
  • Disposer des permissions API requises.

Installation

Étape 1 : Téléverser l'add-on

Allez dans Panneau d'administration → Extensions → Add-ons, cliquez sur Téléverser un add-on et déposez le fichier .zip de l'add-on dans la zone de téléversement (50 Mo maximum). L'archive est extraite dans extensions/addons/adyen/ et Adyen apparaît dans la liste, désactivé.

Étape 2 : Activer l'add-on

Cliquez sur Activer sur la carte Adyen. C'est un add-on payant : une fenêtre demande son code d'achat, qui est vérifié avant toute autre opération. Un code invalide est refusé dans la fenêtre et rien n'est modifié.

Une fois le code accepté, l'activation se fait en une seule passe : elle crée les tables de base de données de l'add-on (ses migrations), enregistre ses permissions, exécute ses seeders et publie ses assets publics. Rechargez la page pour voir sa nouvelle entrée dans la section Add-ons de la barre latérale d'administration.

Étape 3 : Configurer

Ouvrez Panneau d'administration → Adyen depuis la section Add-ons de la barre latérale et configurez l'add-on : voir Configuration.

Code d'achat (clé de licence)

Adyen est vendu comme un produit séparé, il possède donc son propre code d'achat (clé de licence), distinct du code d'achat de l'application principale et de celui de chaque autre add-on. Il vous est demandé lorsque vous activez Adyen dans Panneau d'administration → Extensions → Add-ons.

Nos produits sont vendus sur trois plateformes. La façon dont vous recevez un code d'achat dépend de l'endroit où vous avez acheté le produit.

1. Boutique bedigit.com (achat sur le site)

• Dès que le statut de paiement de la commande passe à Payée, une clé de licence est générée automatiquement pour chaque article sous licence de la commande (une clé par unité achetée : l'achat de 3 unités donne 3 clés distinctes).
• Elle est envoyée par e-mail à l'adresse utilisée pour la commande, soit dans un e-mail de licence dédié, soit dans l'e-mail de confirmation de commande. Vérifiez votre boîte de réception et votre dossier spam / courrier indésirable.
• La clé reste disponible dans votre compte sous Mon compte → Mes licences. Les clés sont masquées dans la liste ; ouvrez la page de détail de la licence pour afficher et copier la clé complète, voir les domaines sur lesquels elle est activée, et désactiver un domaine pour libérer un emplacement d'activation.
• La facture correspondante se trouve sous Mon compte → Mes commandes.

2. Gumroad

• Un achat sur Gumroad produit deux e-mails distincts : le reçu Gumroad (envoyé par Gumroad, donnant accès aux fichiers) et un e-mail de clé de licence (envoyé par bedigit.com) qui contient votre code d'achat.
• L'e-mail de clé de licence est généré dès que Gumroad nous notifie la vente, il arrive donc normalement quelques secondes après le paiement. Ici aussi, vérifiez votre boîte de réception et votre dossier spam / courrier indésirable.
• Lorsque le produit Gumroad utilise la fonctionnalité de clé de licence propre à Gumroad, la même clé apparaît également dans votre reçu Gumroad et sous Bibliothèque → votre achat sur gumroad.com.
• Utilisez la même adresse e-mail sur bedigit.com que sur Gumroad : vos clés sont alors liées automatiquement à votre compte et listées sous Mon compte → Mes licences, même si vous vous inscrivez après l'achat. Vous pouvez aussi ajouter une clé Gumroad manuellement depuis Mon compte → Mes licences Gumroad.

3. Envato Market (CodeCanyon)

• Les codes d'achat Envato sont délivrés et fournis par Envato Market, et ne sont jamais envoyés par e-mail par nous, il n'y a donc rien à chercher dans votre dossier spam : vous récupérez le code depuis votre compte Envato.
• Connectez-vous à votre compte Envato / CodeCanyon, ouvrez la page Downloads, trouvez l'article et choisissez License certificate & purchase code dans le menu déroulant Download. Le code est inscrit dans ce certificat.
• Un code d'achat Envato ressemble à 12345678-90ab-cdef-1234-567890abcdef (8-4-4-4-12 caractères). Il ne change jamais, et le renouvellement du support de l'article n'en génère pas de nouveau.
• Article officiel d'Envato : Où est mon code d'achat ?

Compatibilité

• v3.0.2 => LaraClassifier v19.1.0+ et JobClass v19.1.0+
• v3.0.1 => LaraClassifier v19.1.0+ et JobClass v19.1.0+
• v3.0.0 => LaraClassifier (v19.0.0 à v19.0.1) et JobClass (v19.0.0 à v19.0.1)
• v2.2.5 => LaraClassifier v18.3.0+ et JobClass v17.3.0+
• v2.2.4 => LaraClassifier v18.2.0 et JobClass v17.2.0
• v2.2.3 => LaraClassifier (v18.0.0 à v18.1.1) et JobClass (v17.0.0 à v17.1.1)
• v2.2.2 => LaraClassifier (v17.0.0 à v17.1.1) et JobClass (v16.0.0 à v16.1.1)
• v2.2.1 => LaraClassifier (v16.0.0 à 16.0.2) et JobClass (v15.0.0 à v15.0.2)
• v2.2.0 => LaraClassifier (v15.2.0 à v15.4.1) et JobClass (v14.2.0 à v14.4.1)
• v2.1.2 => LaraClassifier (v15.1.1 à v15.1.6) et JobClass (v14.1.1 à v14.1.6)
• v2.1.1 => LaraClassifier v15.1.1 et JobClass v14.1.1
• v2.1.0 => LaraClassifier (v15.0.0 à v15.1.0) et JobClass (v14.0.0 à v14.1.0)
• v2.0.0 => LaraClassifier (v14.0.0 à v14.2.0) et JobClass (v13.0.0 à v13.2.0)
• v1.2 => LaraClassifier (v11.0.0 à v13.0.0) et JobClass (v10.0.0 à v12.0.0)
• v1.1 => LaraClassifier (v10.0.0 à v10.2.6) et JobClass (v9.0.0 à v9.2.6)
• v1.0 => LaraClassifier (v10.0.0 à v10.1.4) et JobClass (v9.0.0 à v9.1.5)

Mise à jour

Une mise à jour ne remplace que les fichiers de l'add-on. Ses tables et ses données, ses paramètres, son état d'activation et son code d'achat enregistré sont tous conservés : ne désactivez et ne supprimez pas l'add-on avant de le mettre à jour. Sauvegardez tout de même votre base de données au préalable.

Méthode 1 : Téléverser la nouvelle version (recommandé)

1. Téléchargez le dernier fichier .zip de l'add-on.
2. Allez dans Panneau d'administration → Extensions → Add-ons et cliquez sur Téléverser un add-on.
3. Déposez le fichier .zip dans la zone de téléversement.
4. Comme Adyen est déjà installé, une demande de confirmation affiche la version installée et la nouvelle. Cliquez sur Remplacer : le dossier extensions/addons/adyen/ est remplacé par les nouveaux fichiers. Annuler la demande abandonne le téléversement.

Méthode 2 : Remplacer les fichiers à la main

1. Par FTP ou SSH, supprimez le dossier extensions/addons/adyen/ et envoyez le nouveau à sa place. Remplacez le dossier entier plutôt que de copier par-dessus, afin que les fichiers retirés par la nouvelle version ne subsistent pas.
2. Ouvrez Panneau d'administration → Extensions → Add-ons : la page relit addon.json et la carte affiche le nouveau numéro de version.

Une fois les fichiers remplacés

Nouvelles tables ou colonnes. Lorsqu'une nouvelle version en ajoute, créez-les en exécutant php artisan migrate --force en SSH, ou sans SSH en cliquant sur Désactiver puis Activer sur la carte de l'add-on : l'activation exécute toutes les migrations en attente (et redemande le code d'achat). Vos données ne sont pas touchées dans les deux cas.

Assets publics. Les fichiers publics de l'add-on sont copiés dans public/vendor/adyen/ lors de son activation, et remplacer ses fichiers ne rafraîchit pas cette copie. Lorsqu'une mise à jour les modifie, republiez-les avec php artisan vendor:publish --tag=adyen-assets --force, ou cliquez sur Désactiver puis Activer sur sa carte.

Si votre installation met en cache sa configuration ou ses routes (php artisan config:cache, route:cache), exécutez php artisan optimize:clear après la mise à jour.

Configuration

Obtenir vos identifiants d'API

Récupérez votre clé d'API, votre compte marchand et votre clé client depuis votre Customer Area Adyen. Adyen délivre des identifiants distincts pour ses environnements de test et de production.

Les configurer depuis le panneau d'administration

L'add-on ajoute une entrée Adyen à la section Add-ons de la barre latérale d'administration. Ouvrez-la pour atteindre Panneau d'administration → Adyen, la méthode recommandée pour configurer la passerelle.

Cliquez sur Enregistrer et les réglages s'appliquent immédiatement : il n'y a rien d'autre à vider ni à recompiler.

Les configurer manuellement

Vous pouvez aussi vous passer du formulaire et modifier directement le fichier /.env du script. Ce sont exactement les clés que le formulaire d'administration écrit :

ADYEN_MODE=live
ADYEN_API_KEY=
ADYEN_MERCHANT_ACCOUNT=
ADYEN_CLIENT_KEY=
ADYEN_LIVE_URL_PREFIX=
ADYEN_CHECKOUT_TYPE=card

Exemple d'utilisation :

ADYEN_MODE=your-adyen-mode
ADYEN_API_KEY=your-adyen-api-key
ADYEN_MERCHANT_ACCOUNT=your-adyen-merchant-account
ADYEN_CLIENT_KEY=your-adyen-client-key

NOTE :

• ajouter la variable de mode ADYEN_MODE= avec la valeur sandbox ou live comme ceci ADYEN_MODE=sandbox. Utilisez sandbox pour passer des commandes de test. Si la variable est absente ou vide, le mode est sandbox.
• ADYEN_CHECKOUT_TYPE= accepte card, encryptedCard ou 3dSecure. Si elle est absente ou vide, elle vaut card.

Exécutez php artisan config:clear après avoir modifié /.env à la main si votre installation met sa configuration en cache. Modifier /.env n'active pas la passerelle : utilisez l'interrupteur Actif sur Panneau d'administration → Adyen, ou activez Adyen sous Panneau d'administration → Moyens de paiement.

Traduction

Pour traduire cet add-on dans votre langue :

• Allez dans le dossier des langues : /extensions/addons/adyen/resources/lang/
• Dupliquez le dossier /extensions/addons/adyen/resources/lang/en/ vers /extensions/addons/adyen/resources/lang/<code>/
  NOTE : N'oubliez pas de remplacer <code> par le code de votre langue (par ex. « de » pour l'allemand).
• Ouvrez le fichier /extensions/addons/adyen/resources/lang/<code>/messages.php et traduisez-le.
  NOTE : Pour traduire le fichier, vous devez modifier les valeurs et non les clés du tableau PHP.

Désinstallation

Éteindre un add-on sans rien perdre, c'est le désactiver : allez dans Panneau d'administration → Extensions → Add-ons, cliquez sur Désactiver sur la carte Adyen et confirmez.

• L'add-on n'est plus chargé : ses routes, ses vues, son entrée dans la barre latérale d'administration et ses pages publiques ne répondent plus.
• Ses tables de base de données et toutes les données qu'elles contiennent sont conservées, et ses fichiers restent dans extensions/addons/adyen/. Rien n'est supprimé.
• Ses permissions et son code d'achat enregistré restent en base de données. Seule la suppression les efface.
• La désactivation est refusée tant qu'un autre add-on actif dépend de celui-ci : désactivez d'abord cet add-on.

Cliquez sur Activer sur la même carte pour le rallumer. Comme lors de la première activation, le code d'achat est redemandé et vérifié ; ensuite les migrations en attente sont exécutées, les assets republiés, et l'add-on reprend exactement là où il s'était arrêté.

Suppression

La suppression est définitive et détruit les données de l'add-on. Le bouton Supprimer n'apparaît que sur un add-on désactivé : la suppression se fait donc toujours en deux temps :

1. Désactivez Adyen (voir Désinstallation).
2. Cliquez sur Supprimer sur sa carte et confirmez la demande.

Le panneau d'administration, en une seule passe :

• exécute le hook de désinstallation de l'add-on, s'il en fournit un, tant que son code est encore sur le disque ;
• révoque les permissions déclarées dans son addon.json ;
• annule ses migrations, ce qui supprime ses tables de base de données et toutes les lignes qu'elles contiennent, et purge ses entrées de la table migrations, afin qu'une réinstallation ultérieure reparte de zéro ;
• supprime ses assets publiés : public/addons/adyen/, public/vendor/adyen/ et storage/app/public/addons/adyen/ ;
• supprime le dossier de l'add-on extensions/addons/adyen/ ;
• supprime sa ligne dans la table addons (le code d'achat enregistré disparaît avec elle) et vide le cache de l'application.

La suppression est refusée, avec un message explicatif et avant toute destruction, lorsque l'add-on est encore actif, lorsqu'un autre add-on actif en dépend, ou lorsque l'utilisateur du serveur web (PHP) ne peut pas supprimer extensions/addons/adyen/. Dans ce dernier cas, donnez à cet utilisateur le droit d'écriture sur le dossier et sur son parent, puis réessayez.

Supprimer le dossier en FTP ou en SSH n'est pas équivalent : l'add-on est seulement éteint, et ses tables, ses entrées dans la table migrations et sa ligne addons restent en place. Utilisez plutôt Supprimer dans le panneau d'administration.

Ressources

• Identifiants API Adyen
• API Checkout d'Adyen
• Bibliothèque des API Adyen pour PHP
• Adyen - Numéros de cartes de test