Instellen backoffice koppeling#
Met dit menu kunt u de backoffice koppeling activeren. Hiermee is het mogelijk om alle ordergegevens automatisch te verwerken in uw eigen administratieve systeem.Vereisten script#
Bij iedere geslaagde betaling wordt er door onze server een script aangeroepen op de server van de klant. Dat is zo ingesteld dat onze server 'oke' (plain text, zonder xml of html) terugkrijgt van die van de klant. Als dat een keer niet gebeurt (oke terug), dan blijft onze server het proberen. Eerst een keer er vlak achteraan, na vijf minuten en dan vanaf poging drie met tussenpozen van twee uur gedurende een week lang. Iedere keer als het niet lukt, krijgt de klant een melding, daarin staat 'Retries left : 99' (die 99 is dan het aantal keer dat het nog geprobeerd gaat worden).Voorbeeld scripts in verschillende talen:
Indien u zeker wilt stellen dat het script alleen vanaf de mijnWinkel.nl server wordt aangeroepen, bouw dan een controle in op IP adres. Het IP adres van de mijnWinkel.nl server waarvan deze aanroep wordt gedaan ligt in de range 178.208.62.0/24.
URL script veld#
Voer hier de locatie in van uw eigen script dat de ordergegevens verwerkt. De locatie moet beginnen met http://. Voorbeeld: http://mijnWinkel.nl/cgi-bin/generic_backoffice_demo.pl. Door het veld leeg te maken wordt de backoffice koppeling uitgeschakeld.
Moment van aanroep#
Via deze keuzeoptie kunt u bepalen wanneer het script wordt aangeroepen. Deze keuze is alleen van belang indien betaald wordt via Docdata Payments. Er zijn drie opties:
- direct na de bestelling:
zodra de klant het bestelproces heeft afgerond wordt het script aangeroepen (dit is het moment dat ook de bestelbevestigingen per email worden verzonden) - nadat de order is betaald:
het script wordt pas aangeroepen als de order de status considered_safe heeft gekregen (zie ook tabblad 'orders') - direct na de bestelling en nadat de order is betaald:
het script wordt twee maal aangeroepen: direct na de bestelling en nadat de order de status considered_safe heeft gekregen (zie ook tabblad 'orders')
Het kan gebeuren dat we vlak achter elkaar twee status updates van Docdata Payments krijgen die dan twee keer de backoffice koppeling triggeren. De aanroep van de backoffice koppeling is een status update, niet een transactiemelding. Als er dus twee keer vlak achter elkaar de melding wordt gedaan dat een bestelling is betaald dan is de status betaald.
Dit kan het beste zo in de backoffice applicatie worden geïmplementeerd. Dus de eerste keer dat de backoffice koppeling wordt aangeroepen komt de melding van de bestelling binnen met daarin de actuele status. De volgende keer (keren) wordt een wijziging van de status doorgegeven en als de status considered_safe is geworden, kan de bestelling als 'betaald' worden aangemerkt.
Wij adviseren om altijd om de payment_state te gebruiken en af te wachten op de waarde considered_safe alvorens tot uitlevering van de bestelde goederen te gaan. Het veld order_state bevat de waarde die ook manueel gewijzigd kan worden in orderbeheer.
Het aanroepen van de backoffice koppeling gebeurd op basis van een trigger dat er betaald is (als is ingesteld: 'na betaling aanroepen'), de PSP-er meldt de betaalstatus aan mijnWinkel terug. De backoffice koppeling wordt niet aangeroepen indien de orderstatus in orderbeheer van een order op ´betaald´ wordt gezet.Parameters#
Behalve de bestelgegevens gaan er nog een aantal gegevens mee in de post : ip adres van de klant, datum en tijd, verzend en kortingskosten (indien in gebruik) en betaalmethode. Tevens worden alle velden toegevoegd die in het klantgegevensscherm zijn gedefinieerd.Voor elke regel in de winkelwagen zijn er herhalende velden article, quantity, description en price. Alle prijzen worden als getal doorgegeven.
Hieronder een opsomming van de parameters die meegezonden worden bij de aanroep van het script (uitsluitend indien de parameters zijn gedefinieerd).
Overzicht parameters#
Parameter | Waarde | Voorbeeld |
---|---|---|
order_shopnumber | Shopnummer | 154300 |
ordernumber | Ordernummer | 154300_000012 |
user_login_id | Gebruiker ID | 12 |
user_login_name | Gebruiker naam | Jan |
transaction_id | Transactie ID | 02933488854543 |
Factuur E-mail adres | test@mail.nl | |
company | Factuur Bedrijfsnaam | mijnWinkel.nl |
department | Factuur Afdeling | Verkoop |
name | Factuur Naam | Jan Fictief |
street | Factuur Straatnaam | Zuider Parallelweg |
streetnumber | Factuur Huisnummer | 16 |
zip | Factuur Postcode | 2311 XN |
city | Factuur Woonplaats | Lent |
state | Factuur Provincie / Staat | Gelderland |
country | Factuur Land | nl |
telhome | Factuur Telefoon Thuis | 0316-586644 |
telwork | Factuur Telefoon Werk | 0316-586645 |
mobile | Factuur Telefoon Mobiel | 06-55841232 |
fax | Factuur Fax nummer | 0316-586646 |
remark | Factuur Opmerking | Graag zsm leveren |
delivery_company | Afleveradres Bedrijfsnaam | mijnWinkel.nl |
delivery_department | Afleveradres Afdeling | Verkoop |
delivery_name | Afleveradres Naam | Jan Fictief |
delivery_street | Afleveradres Straatnaam | Zuider Parallelweg |
delivery_streetnumber | Afleveradres Huisnummer | 16 |
delivery_zip | Afleveradres Postcode | 2311 XN |
delivery_city | Afleveradres Woonplaats | Lent |
delivery_state | Afleveradres Provincie / Staat | Gelderland |
delivery_country | Afleveradres Land | nl |
delivery_telhome | Afleveradres Telefoon Thuis | 0316-586644 |
delivery_telwork | Afleveradres Telefoon Werk | 0316-586645 |
delivery_mobile | Afleveradres Telefoon Mobiel | 06-55841232 |
delivery_fax | Afleveradres Fax nummer | 0316-586646 |
partner | Gebruikte affiliate | test@affiliate.nl |
shipping | Gekozen verzendmethode | Standaard verzending |
shipping_value | Verzendkosten | 6.9500 |
payment_method | Betaalmethode | 1 |
payment_state | Betaal status (zelfde als in orderbeheer) | considered_safe |
reduction | Toegepaste korting actie | 10% korting |
reduction_value | Kortingsbedrag | 3.45 |
date | Plaatsingsdatum van de order | 25/11/2009 |
time | Plaatsingstijd van de order | 15:52:52 |
host | IP-adres van de klant | 95.123.45.113 |
order_state | Order status (zelfde als in orderbeheer) | betaald |
last_partial_payment_method | Voor docdata: code betaalmethode | 2 |
articles | Aantal artikelen in deze order | 1 |
currency | De gebruikte valuta | euro |
vat | Totaal bedrag berekende BTW | 4.9576 |
total | Totaal bedrag | 31.0500 |
article0 | Artikelnummer Nummert door indien meer artikelen Bijvoorbeeld: article1, article2, etc | 6554201 |
quantity0 | Aantal Nummert door indien meer artikelen Bijvoorbeeld: quantity1, quantity2, etc | 2 |
description0 | Omschrijving Nummert door indien meer artikelen Bijvoorbeeld: description1, description2, etc | Licht gemeleerde wollen muts |
price0 | Prijs Nummert door indien meer artikelen Bijvoorbeeld: price1, price2, etc | 17.2500 |
Daarnaast worden ook de zelf gedefinieerde NAW gegevens en de gegevens die u doorgeeft als custom_ met de 1-click-basket doorgegeven in de backoffice koppeling. Voorbeeld van een 1-click-basket en het resultaat:
http://$domain$/shop2295/1-click-basket/?product=123&quantity=1&custom_test=geslaagd
Resultaat in de backoffice koppeling (deel van de gegevens):
![]() |
Testen#
Voor het uittesten van de koppeling kunt u gebruik maken van het demonstratiescript met de URL: http://www.mijnwinkel.nl/cgi-bin/generic_backoffice_demo.pl.
U kunt een kopie van de mail naar uzelf laten sturen door uw eigen emailadres mee te geven als parameter cc, dus bijvoorbeeld: http://www.mijnwinkel.nl/cgi-bin/generic_backoffice_demo.pl?cc=help@mijnwinkel.nl.
Wanneer er een fout is opgetreden tijdens het uitvoeren van het script wordt er een mailtje gestuurd naar de winkeleigenaar met de betreffende foutmelding.