Fipn-modulien liittäminen verkkokauppaohjelmiin

Julkaistu: 2009-03-17 | Kirjoittanut: Aivomatic Oy

Fipn-ohjelmistokehystä ja sen eri maksupalvelukohtaisia moduleja ei ole sidottu vain tiettyihin verkkokauppaohjelmistoihin, sillä Fipn on alusta asti kehitetty liitettäväksi kaikkiin muihin ohjelmiin mahdollisimman helposti.

Alla on toimivia käytännön esimerkkejä siitä, miten Fipn-ohjelmistokehyksen eri moduleja voidaan ottaa käyttöön yksinkertaisimmillaan. Ohjelmistokehyksen API-dokumentaatioon tai lähdekoodiin, joissa asiat on kuvattu paljon yksityiskohtaisemmin, ei ole välttämätöntä uppoutua lainkaan.

Eri verkkomaksupalvelujen välillä on eroja. Fipn pyrkii tekemään verkkokaupan ohjelmistokehittäjän elämästä helppoa minimoimalla nämä eri palvelujen väliset erot. Kun verkkokauppaohjelmistoonsa on liittänyt yhden Fipn-modulin, voi seuraavien muiden modulien liittämiseen hyödyntää samaa jo kehitettyä koodia. Tästä hyvänä osoituksena on se, miten samanlaisia alla olevat esimerkit ovat.

Tietojen lähettäminen verkkokaupasta maksupalveluun

Maksutapahtumaan liittyvien tietojen välittäminen verkkokaupasta maksupalveluun tapahtuu asiakkaalle tilausprosessin lopussa esitettävän HTML-maksulomakkeen piilokentissä. Yksinkertaisimmillaan verkkokauppaohjelmistosta pitää saada kaivettua esille vain tiedot tilausnumerosta ja tilauksen loppusummasta. Tätä edustaa ao. esimerkkien $Order-objekti ja sen kuvitteelliset getID- ja getTotal-metodit. Muita tilauskohtaisesti muuttuvia tietoja ei ao. esimerkeissä pakosti tarvita. Muut parametrit voidaan antaa yksinkertaisimmillaan suoraan osana lähdekoodia. Fipn-ohjelmistokehys huolehtii kaikesta muusta, kuten esim. tietojen oikeellisuuden tarkistamisesta, viitenumeroiden ja autentikointikoodin laskemisesta, lomakekenttien muodostamisesta jne.

Verkkokaupan ohjelmistokehittäjän ei siis tarvitse tietää tämän enempää eri verkkomaksupalvelujen rajapintadokumentaatioista. Se säästää runsaasti aikaa ohjelmistokehityksessä ja testauksessa.

Luottokunta

  1.  
  2. try {
  3.     $Sender = Aivomatic_Fipn_Factory::getSender('luottokunta');
  4.     $Sender->setData(
  5.         'ABCDEfghij12',         //Secret merchant ID
  6.         '1234567',              //Public merchant ID
  7.         $Order->getOrderId(),   //Unique order ID
  8.         $Order->getTotal(),     //Order total
  9.         'euro',                 //Currency, must be 'eur' or 'euro', case insensitive
  10.         'http://www.example.com/index.php?option=com_appX&',//Return URL for success
  11.         'http://www.example.com/index.php?option=com_appX&',//Return URL for cancel
  12.         'http://www.example.com/index.php?option=com_appX&',//Return URL for error
  13.         '1');                   //Transaction type. Must be '0' (authorize) or '1' (authorize and capture).
  14.     echo '<form method="post" action="'.$Sender->getPostUrl().'">'; //Print HTML-form
  15.     echo $Sender->getHtmlInputFields($Sender->getFormFields());
  16.     echo '<input type="submit" value="Pay" /></form>';
  17. } catch (Aivomatic_Fipn_Exception $e) {
  18.     echo 'Error: '.$e->getMessage();
  19.     die();
  20. }
  21. ?>

Yllä olevan esimerkin eri parametrien merkitykset:

  • Secret merchant ID eli salainen koodiavain on maksupalvelutoimittajan kauppiaalle toimittama koodi, jonka avulla verkkokaupan ja maksupalvelun välillä liikkuvien tietojen autenttisuus voidaan tarkistaa.
  • Public merchant ID eli kauppiastunnus on maksupalvelutoimittajan kauppiaalle antama tunnuskoodi.
  • Unique order ID on kullekin verkkokaupan tilaukselle yksilöllinen tilaustunnus.
  • Order total on tilauksen loppusumma.
  • Currency eli valuutta. Käytännössä aina Euro, sillä yksikään suomalainen maksupalvelu ei tue muita valuuttoja.
  • Return URL eli paluuosoite johon asiakas ohjataan maksupalvelun sivustolta maksutapahtuman jälkeen. Onnistuneille, peruutetuille ja virheellisille maksuille voidaan haluttaessa antaa erilliset paluuosoitteet, tai yksi ja sama osoite kuten esimerkissä.
  • Transaction type eli tapahtumatyyppi. 0 = Varmenna, 1 = Varmenna ja veloita.

Nordea Pankki

  1.  
  2. require_once 'Aivomatic/Fipn/Factory.php';
  3.  
  4. try {
  5.     $Sender = Aivomatic_Fipn_Factory::getSender('nordeapankki');
  6.     $Sender->setData(
  7.         'abcdefghij',           //Secret merchant ID
  8.         '2345679',              //Public merchant ID
  9.         $Order->getOrderId(),   //Unique order ID
  10.         $Order->getTotal(),     //Order total
  11.         'euro',                 //Currency
  12.         'http://www.example.com/index.php?option=com_appX&',
  13.         'http://www.example.com/index.php?option=com_appX&',
  14.         'http://www.example.com/index.php?option=com_appX&',
  15.         '0001');                //Secret merchant Id key version.
  16.     echo '<form method="post" action="'.$Sender->getPostUrl().'">';
  17.     echo $Sender->getHtmlInputFields($Sender->getFormFields());
  18.     echo '<input type="submit" value="Pay" /></form>';
  19. } catch (Aivomatic_Fipn_Exception $e) {
  20.     echo 'Error: '.$e->getMessage();
  21.     die();
  22. }
  23. ?>

Osuuspankki

  1.  
  2. require_once 'Aivomatic/Fipn/Factory.php';
  3.  
  4. try {
  5.     $Sender = Aivomatic_Fipn_Factory::getSender('osuuspankki');
  6.     $Sender->setData(
  7.         'JIHGFEDCBA',           //Secret merchant ID
  8.         '34567890',             //Public merchant ID
  9.         $Order->getOrderId(),   //Unique order ID
  10.         $Order->getTotal(),     //Order total
  11.         'euro',                 //Currency
  12.         'http://www.example.com/index.php?option=com_appX&',
  13.         'http://www.example.com/index.php?option=com_appX&',
  14.         'http://www.example.com/index.php?option=com_appX&',
  15.         '1');                //Secret merchant Id key version.
  16.     echo '<form method="post" action="'.$Sender->getPostUrl().'">';
  17.     echo $Sender->getHtmlInputFields($Sender->getFormFields());
  18.     echo '<input type="submit" value="Pay" /></form>';
  19. } catch (Aivomatic_Fipn_Exception $e) {
  20.     echo 'Error: '.$e->getMessage();
  21.     die();
  22. }
  23. ?>

Sampo Pankki

  1.  
  2. require_once 'Aivomatic/Fipn/Factory.php';
  3.  
  4. try {
  5.     $Sender = Aivomatic_Fipn_Factory::getSender('sampopankki');
  6.     $Sender->setData(
  7.         '12345abcde',           //Secret merchant ID
  8.         '45678901',             //Public merchant ID
  9.         $Order->getOrderId(),   //Unique order ID
  10.         $Order->getTotal(),     //Order total
  11.         'euro',                 //Currency
  12.         'http://www.example.com/index.php?option=com_appX&',
  13.         'http://www.example.com/index.php?option=com_appX&');
  14.     echo '<form method="post" action="'.$Sender->getPostUrl().'">';
  15.     echo $Sender->getHtmlInputFields($Sender->getFormFields());
  16.     echo '<input type="submit" value="Pay" /></form>';
  17. } catch (Aivomatic_Fipn_Exception $e) {
  18.     echo 'Error: '.$e->getMessage();
  19.     die();
  20. }
  21. ?>

Paluutietojen vastaanottaminen maksupalvelusta verkkokauppaan

Maksutapahtuman lopuksi asiakas ohjataan maksupalvelun verkkosivustolta takaisin verkkokauppaan. Asiakkaan mukana maksupalvelusta saadaan paluutietoa HTML GET-metodin parametreina siitä, onnistuiko maksutapahtuma, peruuttiko asiakas maksun tai tapahtuiko jossain vaiheessa jokin virhe. Yksinkertaisimmillaan tämän tiedon vastaanottamiseen riittää alla oleva esimerkkikoodi, joka jo sellaisenaan pystyy käsittelemään kaikkien edellä olleiden esimerkkien eri maksupalvelujen paluutiedot. Lisäksi käytännössä voi olla hyödyllistä kirjoittaa myös pätkä koodia, joka tallettaa tiedon maksutapahtuman lopputuloksesta verkkokaupan tilaustietoihin tai esim. lähettää verkkokauppiaalle sähköpostiviestin. Esimerkissä tätä symbolisoi kuvitteellinen $Order-objekti ja sen metodit.

Verkkokaupan ohjelmistokehittäjä pääsee siis taas hyvin helpolla, sillä Fipn-ohjelmistokehys huolehtii vastaanotettujen tietojen yhteinäisestä tulkitsemisesta ja autentikoinnista. Eri maksupalvelujen eroista ja rajapintadokumentaatiosta ei tarvitse taaskaan tietää mitään tämän yksityiskohtaisempaa.

  1.  
  2. $secrets = array('luottokunta'  => '1234567890',
  3.                  'nordeapankki' => 'abcdefghij',
  4.                  'osuuspankki'  => 'JIHGFEDCBA',
  5.                  'sampopankki'  => '12345abcde');
  6.  
  7. require_once 'Aivomatic/Fipn/Factory.php';
  8.  
  9. $gateway = Aivomatic_Fipn_Factory::getPaymentGatewayName($_GET);
  10.  
  11. $secretMerchantId = $secrets[$gateway];
  12.  
  13. try {
  14.     $Receiver = Aivomatic_Fipn_Factory::getReceiver($secretMerchantId, $_GET);
  15. } catch (Aivomatic_Fipn_Exception $e) {
  16.     echo 'Error: '.$e->getMessage();
  17.     die();
  18. }
  19.  
  20. $Order = new App_X_Order($Receiver->getOrderId());
  21.  
  22. if ($Receiver->getIsSuccess()) {
  23.     //Just an example of user output
  24.     echo 'Payment of order '.$Receiver->getOrderId().' was successful';
  25.     $Order->setPaymentStatus('success');
  26. } elseif ($Receiver->getIsCancel()) {
  27.     echo 'Payment was canceled by the customer';
  28.     $Order->setPaymentStatus('cancel');
  29. } elseif ($Receiver->getIsError() AND
  30.           $Receiver->getIsAuthenticResponse() === true) {
  31.     echo 'An error occured during payment';
  32.     $Order->setPaymentStatus('error');
  33. } elseif ($Receiver->getIsError() AND
  34.           $Receiver->getIsAuthenticResponse() === false) {
  35.     echo 'Payment could not be authenticated';
  36.     $Order->setPaymentStatus('error');
  37. }
Kategoria(t): PHP, Tuotteet Avainsana(t): , , , , . Lisää kestolinkki kirjanmerkkeihisi.

Vastaa

Sähköpostiosoitettasi ei julkaista. Pakolliset kentät on merkitty *

*

Voit käyttää näitä HTML-tageja ja attribuutteja: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>