Kit d’intégration PHP

S’abonner
Le kit PHP est composé des éléments suivants :
  • une notice d’installation du kit de développement.
  • un descripteur composer.json pour le téléchargement via Composer de la librairie de fonction qui permet d’utiliser les fonctions de l’API Payline
  • un exemple d’application web utilisant le SDK.
En décompressant le fichier zip, on trouve trois répertoires :

Le répertoire « exemples »
Le répertoire « exemple » correspond à l'application web implémentant l’ensemble des fonctionnalités Payline disponible via la librairie PHP. Chaque fonctionnalité se décline sous la forme de deux fichiers : 

  • un fichier <nom_fonction>Form.php contenant le formulaire de présentation.
  • un fichier <nom_fonction>.php qui récupère les données transmises par l’utilisateur via le formulaire. Le code PHP réalise l’appel au Web Service souhaité.
 
Par exemple, la fonctionnalité « doWebPayment » qui permet la réalisation d’un paiement Web via le kit, se traduit par la présence des deux fichiers suivant :
  • doWebPaymentForm.php : Ce fichier simule la page récapitulatif de la commande de votre client. Elle constitue l’étape 0 dans le processus de paiement web. Vous pouvez modifier les valeurs des champs du formulaire : Amount, Currency et OrderRef pour réaliser des paiements tests.
  • doWebPayment.php : Ce fichier contient le code PHP qui récupère les informations transmises par le formulaire et utilise la librairie pour initialiser une demande de paiement web.
 
Le répertoire « lib » 
Il regroupe les classes qui décrivent les demandes, réponses et objets de l’API SOAP Payline.
  • lib_debug.php : C’est la librairie de débug qui permet l’affichage sous forme de tableau imbriqué du message retour de vos demandes à l’API SOAP Payline.
  • CONFIG.php : Ce fichier contient les paramètres de connexion à Payline, ainsi que les paramètres (contrats, version, devise,...) affichés par défaut dans les pages d'exemple.
    Le fichier CONFIG.php peut être édité directement, ou via le formulaire inclu dans la rubrique Home.
 
Le répertoire « logs »
Au sein de l’archive, ce répertoire est vide. Il correspond au répertoire par défaut d’écriture des traces.

Un fichier <date>.log (<date> étant au format aaaa-mm-jj) est créé et/ou alimenté lors de chaque appel à une fonction de la librairie.

La fonction d’ajout d’une ligne dans ce fichier se nomme writeTrace. C’est une fonction publique de la classe paylineSDK, qui peut donc être réutilisée.

Fonctions
L’ensemble des fonctions Payline sont couvertes par le kit PHP.
La classe paylineSDK propose une fonction correspondant à chaque web service, portant le même nom que ce dernier (doWebPayment, doAuthorization, …).

Appel
Le passage de paramètre entre votre boutique et ces fonctions se fait via un tableau associatif. Examinez les scripts d’exemple contenus dans le kit pour comprendre ce mécanisme.

Retour
La réponse d’un web service Payline est également stockée par le kit dans un tableau associatif. Examinez les scripts d’exemple contenus dans le kit pour comprendre la lecture d’une réponse.
 
Cas particulier :
Si lors de l’appel à une fonction du kit une exception se produit (par exemple en raison d’une absence de communication avec Payline du fait du mauvais paramétrage de l’authentification ou de proxy), une réponse contenant le code XXXXX ainsi que le libellé de l’exception est renvoyée.
Cette réponse n’est pas retournée par Payline, mais par le kit PHP.

Installation
Téléchargez l'achive payline-php-samples-master.zip
Décompressez l'archive à la racine de votre serveur web. Si vous n'utilisez pas encore Composer, téléchargez l'exécutable composer.phar via https://getcomposer.org/download/ et déposez le au même niveau que le fichier composer.json inclu dans l'archive.
Via une invite de commande lancez php composer.phar install
Composer créée le répertoire vendor et y dépose la dernière version du SDK PHP Payline, ainsi que les librairies liées.
 
Configuration du kit
 
Le fonctionnement du kit nécessite l’activation des extensions PHP suivantes sur votre serveur : php_curl, php_http, php_openssl, php_soap
 
Vous devez renseigner les paramètres dans le formulaire "configuration" de la rubrique "Home", ou directement dans le fichier CONFIG.php situé sous le répertoire lib.

MERCHANT_ID : l’identifiant de votre compte commerçant, déclaré dans une chaine de caractères.
ACCESS_KEY : la clé d’accès associé à votre compte commerçant
ACCESS_KEY_REF : la référence web2token associée à votre clé d’accès
PROXY_HOST : l’URL de votre proxy Internet
PROXY_PORT : le port de communication de votre proxy Internet
PROXY_LOGIN : l’identifiant utilisateur requis par votre proxy Internet
PROXY_PASSWORD : le mot de passe utilisateur requis par de votre proxy Internet
ENVIRONMENT : indicateur qui permet déterminer l'environnement Payline vers lequel les requêtes sont adressées. Deux valeurs sont utilisables par les commerçants : HOMO (environnement d'homologation, pour réaliser les tests d'intégration) et PROD (environnement de production).
WS_VERSION : version applicative des web services Payline.
PAYMENT_CURRENCY : le code ISO de la devise à utiliser par défaut pour le paiement
ORDER_CURRENCY : le code ISO de la devise à utiliser par défaut pour la commande
SECURITY_MODE : le code du mode de sécurité à utiliser par défaut
LANGUAGE_CODE : le code ISO de la langue à faire afficher par défaut
PAYMENT_ACTION : le code de la méthode de paiement à utiliser par défaut
PAYMENT_MODE : le mode de paiement à utiliser par défaut
CANCEL_URL : l’URL d’annulation utilisée lorsque le paiement a été refusé ou que votre client a annulé le paiement
NOTIFICATION_URL : l’URL de notification utilisée lorsque Payline vous notifie d’un paiement effectué
RETURN_URL : l’URL de retour utilisée lorsque le paiement a été accepté
CUSTOM_PAYMENT_TEMPLATE_URL : l’URL du template dynamique à appliquer aux pages web de paiement
CUSTOM_PAYMENT_PAGE_CODE : le code de personnalisation des pages de paiement Payline à utiliser par défaut.
CONTRACT_NUMBER : le numéro de contrat qui identifie votre point de vente et votre moyen de paiement par défaut,
CONTRACT_NUMBER_LIST : la liste des numéros de contrat à faire afficher si vous en possédez plusieurs. Sinon votre numéro de contrat unique.
SECOND_CONTRACT_NUMBER_LIST : la liste des numéros de contrat à faire afficher lorsque la première tentative de paiement est un échec.
 
Compatibilité du kit
Le kit PHP est testé avec l’environnement suivant :
  • Windows 7 Professionnel - CentOS release 6.7 (Final)
  • Apache 2.2.22
  • PHP 5.3.13 à 5.6.18
 
Vous avez d’autres questions ? Envoyer une demande

Commentaires

  • Avatar
    zivy

    cela a l'air un peu compliqué pour mon niveau de développement...

Réalisé par Zendesk