php sdk

php sdk MultiSafepay

À propos de MultiSafepay

MultiSafepay est un fournisseur néerlandais de services de paiement qui s'occupe des contrats, du traitement des transactions et de la collecte des paiements pour une gamme de méthodes de paiement locales et internationales. Commencez à vendre en ligne dès aujourd'hui et gérez toutes vos transactions en un seul endroit !

Installation

Exécutez la commande composer suivante :

composer require multisafepay/php-sdk

AVERTISSEMENT! Ce SDK n'a pas de dépendance directe sur Guzzle ou cURL. Au lieu de cela, il utilise l’abstraction client PSR-18 et l’abstraction usine PSR-17. Cela vous permet de choisir l'implémentation PSR-7 et le client HTTP à utiliser. Vous pouvez remplacer tous les clients sans aucun effet secondaire.

Si aucune implémentation client n'est installée, exécutez :

composer require guzzlehttp/guzzle

Si aucune implémentation d'usine n'est installée, exécutez :

composer require http-interop/http-factory-guzzle

Vous devriez maintenant avoir installé :

• Implémentation du client PSR-18
• Implémentation en usine PSR-17
• Implémentation des messages PSR-7

Commencer

Utilisez le chargeur automatique Composer pour charger automatiquement les dépendances de classe :

 require ' vendor/autoload.php ' ;

Ensuite, instanciez le SDK avec la clé API de votre site et un indicateur pour identifier s'il s'agit de l'environnement en direct ou de l'environnement de test.

 $ yourApiKey = ' your-api-key ' ;
$ isProduction = false ;
$ multiSafepaySdk = new  MultiSafepay  Sdk ( $ yourApiKey , $ isProduction );

Depuis le SDK, vous pouvez obtenir différents gestionnaires :

 $ multiSafepaySdk -> getTransactionManager ();
$ multiSafepaySdk -> getGatewayManager ();
$ multiSafepaySdk -> getPaymentMethodManager ();
$ multiSafepaySdk -> getIssuerManager ();
$ multiSafepaySdk -> getCategoryManager ();
$ multiSafepaySdk -> getTokenManager ();
$ multiSafepaySdk -> getApiTokenManager ();

Le gestionnaire de transactions est le plus important, car il vous permet de créer des commandes et des remboursements.

 use MultiSafepay  ValueObject  Customer  Country ;
use MultiSafepay  ValueObject  Customer  Address ;
use MultiSafepay  ValueObject  Customer  PhoneNumber ;
use MultiSafepay  ValueObject  Customer  EmailAddress ;
use MultiSafepay  ValueObject  Money ;
use MultiSafepay  Api  Transactions  OrderRequest  Arguments  CustomerDetails ;
use MultiSafepay  Api  Transactions  OrderRequest  Arguments  PluginDetails ;
use MultiSafepay  Api  Transactions  OrderRequest  Arguments  PaymentOptions ;
use MultiSafepay  Api  Transactions  OrderRequest ;

$ yourApiKey = ' your-api-key ' ;
$ isProduction = false ;
$ multiSafepaySdk = new  MultiSafepay  Sdk ( $ yourApiKey , $ isProduction );

$ orderId = ( string ) time ();
$ description = ' Order # ' . $ orderId ;
$ amount = new Money ( 2000 , ' EUR ' ); // Amount must be in cents!!

$ address = ( new Address ())
    -> addStreetName ( ' Kraanspoor ' )
    -> addStreetNameAdditional ( ' (blue door) ' )
    -> addHouseNumber ( ' 39 ' )
    -> addZipCode ( ' 1033SC ' )
    -> addCity ( ' Amsterdam ' )
    -> addState ( ' Noord Holland ' )
    -> addCountry ( new Country ( ' NL ' ));

$ customer = ( new CustomerDetails ())
    -> addFirstName ( ' John ' )
    -> addLastName ( ' Doe ' )
    -> addAddress ( $ address )
    -> addEmailAddress ( new EmailAddress ( ' [email protected] ' ))
    -> addPhoneNumber ( new PhoneNumber ( ' 0208500500 ' ))
    -> addLocale ( ' nl_NL ' );

$ pluginDetails = ( new PluginDetails ())
    -> addApplicationName ( ' My e-commerce application ' )
    -> addApplicationVersion ( ' 0.0.1 ' )
    -> addPluginVersion ( ' 1.1.0 ' );

$ paymentOptions = ( new PaymentOptions ())
    -> addNotificationUrl ( ' http://www.example.com/client/notification?type=notification ' )
    -> addRedirectUrl ( ' http://www.example.com/client/notification?type=redirect ' )
    -> addCancelUrl ( ' http://www.example.com/client/notification?type=cancel ' )
    -> addCloseWindow ( true );

$ orderRequest = ( new OrderRequest ())
    -> addType ( ' redirect ' )
    -> addOrderId ( $ orderId )
    -> addDescriptionText ( $ description )
    -> addMoney ( $ amount )
    -> addGatewayCode ( ' IDEAL ' )
    -> addCustomer ( $ customer )
    -> addDelivery ( $ customer )
    -> addPluginDetails ( $ pluginDetails )
    -> addPaymentOptions ( $ paymentOptions );

$ transactionManager = $ multiSafepaySdk -> getTransactionManager ()-> create ( $ orderRequest );
$ transactionManager -> getPaymentUrl ();

Exemple de remboursement :

 // Refund example.
use MultiSafepay  Api  Transactions  RefundRequest ;
use MultiSafepay  ValueObject  Money ;

$ yourApiKey = ' your-api-key ' ;
$ isProduction = false ;
$ multiSafepaySdk = new  MultiSafepay  Sdk ( $ yourApiKey , $ isProduction );

$ orderId = XXXXX ;  // The order ID of a previously completed transaction
$ refundAmount = new Money ( 2000 , ' EUR ' );
$ transactionManager = $ multiSafepaySdk -> getTransactionManager ();
$ transaction = $ transactionManager -> get ( $ orderId );
$ transactionManager -> refund ( $ transaction , ( new RefundRequest ())-> addMoney ( $ refundAmount ) );

Pour des exemples de création de requêtes complètes, voir USAGE.md et les tests fonctionnels dans tests/Functional/Api/Transactions .

Utilisation avancée : mode strict

Mode strict :

• Ajoute des validations supplémentaires en plus de diverses requêtes et réponses API.
• Les erreurs de validation génèrent une exception que vous devez gérer.
• Il est activé dans les tests.

Le mode non strict (par défaut) ignore certaines erreurs de validation.

Exemple : s'il existe une différence entre le nombre de décimales du montant total des articles dans l'objet ShoppingCart et votre plateforme de commerce électronique, le mode strict génère une exception MultiSafepayExceptionInvalidTotalAmountException .

Contrôles de qualité du code

Les contrôles suivants sont en place pour maintenir la qualité du code :

• PHP CodeSniffer (via ./vendor/bin/phpcs --standard=phpcs.ruleset.xml . )
  • PSR-2
  • Callisthénie d'objet
• Tests PHPUnit (via ./vendor/bin/phpunit )
  • Tests unitaires
  • Tests d'intégration
  • Tests fonctionnels

Essai

• Les tests unitaires fonctionnent sans l'API ni aucune dépendance ( tests/Unit )
• Les tests d'intégration fonctionnent sans l'API mais ont des dépendances ( tests/Integration )
• Les tests fonctionnels fonctionnent avec l'API live ( tests/Functional ) – Clé API requise

Tests unitaires

Pour exécuter des tests unitaires à partir de ce package :

1. Clonez ce référentiel.
2. Pour installer toutes les dépendances, exécutez composer install
3. Exécutez PHPUnit avec la commande suivante : ./vendor/bin/phpunit tests/Unit

Tests fonctionnels

Pour exécuter des tests fonctionnels à partir de ce package :

1. Clonez ce référentiel.
2. Pour installer toutes les dépendances, exécutez composer install .
3. Copiez .env.php.example dans .env.php et ajoutez la clé API de votre site.
4. Exécutez PHPUnit avec la commande suivante : ./vendor/bin/phpunit tests/Functional

Se moquer de l'API pour les tests unitaires et d'intégration

Les tests unitaires et d'intégration s'exécutent sans l'API, ce qui signifie que le client se moque de tous les appels de données. Pour ce faire, le dossier tests/fixture-data contient des fichiers JSON pour usurper les appels. Pour remplir ce dossier avec des données réelles, assurez-vous d'avoir un fichier .env.php valide, puis utilisez la commande suivante :

 php tests/generateApiMocks.php

Cela valide tous les fichiers JSON générés dans git, afin qu'ils servent de luminaires. Les fichiers qui ne sont pas utilisés dans les tests n'ont pas besoin d'être générés.

Soutien

Créez un problème sur ce référentiel ou envoyez un e-mail à [email protected]

Contributeurs

Si vous créez une pull request pour suggérer une amélioration, nous vous enverrons des cadeaux MultiSafepay en guise de remerciement !

Licence

Licence de logiciel ouvert (OSL 3.0)

Voulez-vous faire partie de l'équipe?

Êtes-vous un développeur intéressé à travailler chez MultiSafepay ? Consultez nos offres d'emploi et n'hésitez pas à nous contacter !