Developer Network API 2.0

API 2.0

Algemeen

U kunt bij ICEPAY gebruik maken van verschillende API’s. De API 2.0 is de meest up-to-date API van ICEPAY. De ICEPAY API 2.0 is in vergelijking tot de API 1.0 gemakkelijker te integreren in uw project en biedt een grotere mate van flexibiliteit in het ontwikkelen. De API 2.0 biedt een breed scala aan mogelijkheden om de betaalmethoden in uw webshop nu nog beter te beheren. Dit leidt uiteindelijk tot meer gebruiksgemak voor uw klant en meer conversie binnen uw webshop!

LET OP:
ICEPAY API 2.0 is alleen beschikbaar voor PHP en NIET compatible met de 1.0 API. Voorgaande ICEPAY API versies zijn beschikbaar voor zowel PHP als .NET

Mogelijkheden

In vergelijking tot de API 1.0, heeft de ICEPAY API 2.0 diverse extra features te bieden:

Nauwe integratie in uw project
Het is nu nog makkelijker om de ICEPAY API in uw project te integreren. Zo kunt u gebruik maken van ICEPAY statuscode constants, de API log functie koppelen aan uw eigen logger en de betaalmethoden programmatisch laden.
Programmatisch laden van betaalmethoden
Het is nu mogelijk om de betaalmethoden en de issuers van deze betaalmethoden programmatisch te laden. Zo kunt u bijvoorbeeld de betaalmethoden als array ophalen.
Filteren van betaalmethoden
Het is mogelijk om de betaalmethoden locaal te filteren op belangrijke parameters. Laat bijvoorbeeld in uw project enkel de betaalmethoden zien waar men met USD kan betalen. Het filteren is mogelijk op land, taal, valuta en bedrag.
Updaten
De betaalmethode classes zijn gescheiden van de hoofd API classes. Doordat de betaalmethoden programmatisch ingeladen worden, hoeft u als developer niets meer te schrijven. U hoeft dan alleen de folder te updaten met nieuwe betaalmethoden of eigen betaalmethode scripts.
Meer flexibiliteit
De nieuwe API biedt meer flexibiliteit in het ontwikkelen. Zo kunt u de diverse settings configureren en zelf opgeven welke betaalmethoden geladen worden. Er zijn diverse nieuwe methoden toegevoegd om het implementeren te versimpelen en te beveiligen.
Speciale classes voor postback en success/error pagina’s
De nieuwe module biedt afgestemde classes om de postback en de terugkerende klant af te vangen.
Controle parameters
De nieuwe API controleert de opgegeven parameters voordat er een call naar ICEPAY gemaakt wordt.
Log functies
De nieuwe log functie biedt u de mogelijkheid om naar het scherm, een bestand of uw eigen log functie te schrijven en is voorzien van seconde nauwkeurigheid.
Sample scripts
De nieuwe API komt gepaard met sample scripts en ‘best practices’ voorbeelden zodat u meteen aan de slag kunt..

Wij wijzen u er op dat deze nieuwe API versie van ICEPAY enkel geschikt is om te gebruiken als u in PHP werkt. Gebruikers van .NET adviseren wij aan om met ICEPAY 1.0 te (blijven) werken.

PHP

Voorbeeld van het starten van een betaling met de API 2.0:

$payment = new Icepay_Basicmode();

$payment->setMerchantID(10000)
      ->setSecretCode("Nm7e8Mz3KAr64TLn68Cj5Swx5Fd3BYt74DfJs9acYt74D");

$payment->setAmount(1000)
    ->setCountry("NL")
    ->setLanguage("NL")
    ->setCurrency("EUR")
    ->setReference("My Sample Website")
    ->setDescription("My Sample Payment");

$url = $payment->setOrderID("test01")->getURL();

header( "location: " . $url );

Sample scripts

API 2.0 sample scripts

Download sample scripts

Gebruik alleen de sample scripts die u vindt op de API 2.0 pagina. Deze sample scripts zijn alleen bestemd voor trainingsdoeleinden en dienen niet gebruikt te worden in een live omgeving.

Sample script: Starten van een betaling – ICEPAY Basicmode

Dit voorbeeldscript toont hoe u een betaling kan starten met het Basicmode betaalmethoden-selectie-scherm. Dit houdt in dat de eindgebruiker op een ICEPAY pagina de betaalmethoden kan kiezen.

Sample script: Starten van een betaling – iDeal

Dit voorbeeld script toont hoe u een enkele betaalmethode inlaadt, in dit geval iDeal. Het script leest de banken uit en gebruikt deze om een betaling te starten. De gegenereerde URL zal de eindgebruiker direct naar de iDeal betaalpagina sturen, uw klant krijgt dus geen ICEPAY pagina's te zien.

Sample script: Starten van een betaling – Betaalmethode filteren

Om volledig gebruik te maken van alle API functionaliteiten kunt u het beste de betaalmethoden programmatisch inladen en filteren gebaseerd op het afrekenproces van de eindgebruiker. De gegevens waarop u dit kunt baseren zijn o.a.: valuta, totaalbedrag en factuur adres. Dit voorbeeld toont hoe u een betaling met filtering start.

Let op dat dit script voor testdoeleinden GEEN order ID gebruikt. Daarom kan de betaling niet opgevangen worden door het result/postback script. Gebruik altijd een uniek gegenereerde order ID.

Sample script: Afhandelen van een betaling – Result pagina

Dit voorbeeldscript handelt de terugkerende eindgebruiker af. Toon een bericht naar uw eindgebruikers betreft de status van hun transactie. Het result script kan gebruikt worden voor zowel de 'Bedankt'- als 'Fout' URL.

Sample script: Afhandelen van een betaling – Postback pagina

Dit script handelt de ‘Postback’ URL af. Dit is het script dat alle transacties hoort af te handelen. Dit is dus een heel belangrijk script binnen uw implementatie.

Snel naar

Disclaimer

The merchant is entitled to change de ICEPAY plug-in code, any changes will be at the merchant's own risk. All work done by ICEPAY related to support for the modified plug-in will be charged in accordance with the standard ICEPAY tariffs.