JVZoo IPN Integration

What is IPN

IPN is Instant Payment Notification, IPN makes possible that JVZOO clients´s scripts get notified automatically upon new order has been received or someone has requested refund. With IPN its possible to automate sales and refunds and re-act almost realtime. You will not need any manual interaction anymore if you have setuped IPN Backend. Typically IPN is a script hosted on your server, you have to tell JVZOO about your URL and JVZOO will send data to this url internally. Your clients (person who has purchased the product) does not see anything, everything happens automatically in background

Requirements

You need a valid JVZOO account, if you dont have an Account, you can Signup one at here. You will need api2.php file from MQLLock API|Downloads section. See details about api2 here. Knowledge about PHP is required to make modifications or you have someone who understands PHP basics. You will also need a hosting with Pear::Mail Enabled PHP and FTP Account to upload files. It is not necessary but you will need a valid email account with smtp authentication for debugging reasons, this is highly recommended. Our script sends every action to you as log, either Success or Fail, you will see everything in email. IPN is normally blind and mute script but we have made it chatty to detect every problem.

You will require a secret key, you can define ‘JVZIPN Secret Key’ inside My Accout->Your Personal Account Information section or simply go to https://www.jvzoo.com/myaccount after you have logged in. You will see “JVZIPN Secret Key” sectio to edit. Make sure to set it to something complex. Secret key is defined for whole account

Installation

Upload api2.php and ipn.php to your hosting, edit ipn.php with your settings (see Video). Assume your domain is ‘maindomain.com’, we recommend you to create a subfolder ‘/ipn’ and put ‘ipn.php’ into this folder along api2.php. Your IPN Url would be ‘http://maindomain.com/ipn/ipn.php’.

You will need to setup ipn url for every single product. We recommend you to setup 1 ipn.php url and configure all ipn urls to that target. To setup ipn url per product you go to Sellers Dashboard and click to Edit by particular Product and configure the url under “EXTERNAL PROGRAM INTEGRATION” section like seen here:

Introduction Video

This video does not belong to JVZOO but this video explains on second part how you can edit the ipn.php (in video it is single.php). Most of editing rules are also valid for JVZOO, especially it is important to understand product and mqllock account mapping

Authentication

Current version of ipn.php is using Receipt number as authentication credential on MQLLock. Upon real sale your client gets an unique Receipt number assigned, this number is known to you and your client. If you want to use different token to authenticate, you can modify ipn.php accordingly.

IPN Docs

JVZOO has some IPN Documentation available here. You will need to be signed in, in order to view this page. Please login first to your account and click to this link.

Testing IPN

JVZOO does offer IPN Testing but best way to test ist to create a new product for 1$ and test things live.

Product -> Mqllock Account Mapping

You will see $CONFIG array inside ipn.php, this is your friend to map which product from JVZOO should active the account where. Casually spoken the ProductID “123” will open an account inside mqllock account with ipn auth code “xxx”. You will need to setup IPN accordingly inside your PROFESSIONAL Mqllock account, see video we provide to setup your mqllock account to make it ready to work with IPN. Then find out your products productID. Best way to do this is to go to Sellers Dashboard, click to “Buy Buttons” link on particular product and look for the number in generated urls. For example :

Here you see yellow marked id is the product id. Every product has a unique product id. You will need to implement this id into $CONFIG array and put API Auth (generated in video) to auth. Then product is mapped to mqllock.

Debugging

IPN is very important and you should not miss any errors or mistakes. Thats why we have prepared very detailed Debugging Output. You will receive from that script very detailed output as email per session. A Session is 1 IPN Transaction. We recommend you to check these logs in detail first weeks to find problems.

Future

Script here is working for many purphoses, but you might need to modify/extend this script to adapt to other needs. For this you will need to understand php and mqllock api coding. This script covers almost everything to get started for normal marketting needs. Advanced users can modify it as they need.

Outsource

If you aren´t PHP developer you can hire a freelancer to do this job, he will be able to understand everything after reviewing this page and api2 page. Also make sure this person watches introduction video to get started. If you stuck on minor things contact us, we will help you to finish your ipn setup.

Download

You can download files here

Tagged with: , ,
Posted in help

Leave a Reply

Your email address will not be published. Required fields are marked *

*

*