JVZoo API v2.0 ¶

Introduction ¶

The REST APIs provides programmatic access to data in JVZoo.com. With JVZoo’s API you can retrieve Transaction Summaries, Affiliate Status, Recurring Payment Information, and much more. The REST API identifies JVZoo Applications using Basic Auth; responses are in JSON.

Versions ¶

Latest Stable Version: v2.0

This Version: v2.0

Click to make sure you are looking at the latest version!

Calling the API ¶

Requests (Authorization) ¶

All requests sent to the JVZoo REST API need to be authenticated with valid a API Key over HTTPS. This is to prevent unauthorized access to your account through the API.

To obtain an API key, you first need go to https://www.jvzoo.com/account/applications to create a new API Application under the My Account tab.

Once created, your API key for the active app will be shown under Vendor Applications at http://www.jvzoo.com/account/applications/index.

We will use this API Key to verify your identity on each API call you make. The URL of the JVZoo API v2.0 is:

https://api.jvzoo.com/v2.0

In the examples below, simply replace MyAPIKeyString with your API Key and put in the full api url. Note: leave x in the password portion.

Example Command Line Code: If your API Key is MyAPIKeyString then you can call JVZoo API using curl like:

curl -u MyAPIKeyString:x https://api.jvzoo.com/v2.0

Example PHP Code:

Responses ¶

For ease of use and simplicity for the developers that integration with our API, we have adopted a common response for ALL API calls.

Custom headers and the set of attributes do not change from call to call - only the values of the attributes and the content of the results array are different from call to call

Custom Headers ¶

Every response has the default headers (some shown below), however we also include a custom header X-API-Version in all responses to make it easier to debug.

HTTP/1.0 200 OK
Date: Fri, 30 Oct 2015 10:26:52 GMT
X-API-Version: 2.0
Cache-Control: no-cache
Content-Length: 162
Connection: close
Content-Type: application/json

Sample Response ¶

{
"meta": {
    "status": {
        "http_status_code": 200,
        "code": 2000,
        "message": "Success",
        "detail": null
    },
    "results_count": 1,
    "api_version": "2.0"
},
"results": [
    {
        "id": 1,
        "name: "John Doe",
        "age": 23,
        "birthday": "1991-10-18"
    }
]
}

HTTP Status Codes ¶

The JVZoo API uses the common and conventional HTTP response codes to show the success and failures of an API request. The following is a list of response codes that are used.

Response Codes ¶

Bad or Invalid Responses ¶

All responses (except 204) return the same response body structure as a successful response but with the proper attributes set.

• Response 204 - based on the specification a 204 the response cannot return a body but only the headers.

• Example Response 400

{
    "meta": {
        "status": {
            "http_status_code": 400,
            "code": 4001,
            "message": "Invalid Parameters",
            "detail": null
        },
        "results_count": 1,
        "api_version": "2.0"
    },
    "results": [
        null
    ]
}

Payment Statuses ¶

Affiliate Status ¶

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success",
      "detail": null
    },
    "results_count": 1,
    "api_version": "2.0"
  },
  "results": [
    {
      "created": "2014-07-31T19:06:11+00:00",
      "product_id": 123456,
      "affiliate_id": "12345",
      "comments": "My Test Comments",
      "status_id": 2,
      "custom_commission": "0.75",
      "delayed_commission": "0"
    }
  ]
}

Payments ¶

Content-Type: application/json

{
  "status": "CANCEL"
}

Content-Type: application/json

{
"meta": {
    "status": {
        "http_status_code": 200,
        "code": 1000,
        "message": "Success",
        "detail": null
    },
    "results_count": 1,
    "api_version": "2.0"
},
"results": [
    {
        "canceled": TRUE
    }
]
}

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success",
      "detail": null
    },
    "results_count": 1,
    "api_version": "2.0"
  },
  "results": [
    {
      "id": 123456,
      "status": "ACTIVE",
      "current_payments": 6,
      "max_number_of_payments": 13,
      "max_total_of_all_payments": "37.00",
      "max_amount_per_payment": "3.00",
      "next_payment": "3.00",
      "paypal_email": "[email protected]",
      "contact_email": "[email protected]",
      "code": null,
      "price": "3.00",
      "payment_period": 1,
      "payment_count": 12,
      "payment_first_payout": "0.25",
      "has_payment_trial": true,
      "payment_trial_price": "1.00",
      "payment_trial_period": 3,
      "payment_trial_payout": "0.5",
      "payout": null,
      "current_payments_amount": "16.00",
      "created": "2015-06-19T13:12:44+00:00",
      "preKey": "PA-1234567890ABCDEFG",
      "sender_email": "[email protected]",
      "last_date": "2015-10-23T04:00:00+00:00",
      "next_date": "2015-11-23T05:00:00+00:00",
      "ip": "1.1.1.1",
      "referrer": "https://www.domain.com",
      "tid": null,
      "vtid": null,
      "product_id": 123456
    }
  ]
}

Transactions ¶

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success",
      "detail": null
    },
    "results_count": 1,
    "api_version": "2.0"
  },
  "results": [
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "date": "2014-12-19T12:49:16+00:00",
      "product_name": "My Product",
      "product_id": 123456,
      "status": "COMPLETED",
      "price": "0.75",
      "first_name": "Joe",
      "last_name": "Smith",
      "paypal_email": "[email protected]"
    }
  ]
}

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success",
      "detail": null
    },
    "results_count": 2,
    "api_version": "2.0"
  },
  "results": [
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "date": "2016-12-18T08:09:15+00:00",
      "product_name": "Example Product Name",
      "product_id": 123456,
      "status": "COMPLETED",
      "price": "0.01",
      "customer_email": "[email protected]",
      "ip": "1.1.1.1",
      "first_name": "Joe",
      "last_name": "Smith",
      "affiliate_commission": "0.01",
      "affiliate_commission_status": "UNPAID",
      "affiliate_id": 1,
      "affiliate_name": "Jane Doe"
    },
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "date": "2017-02-21T23:00:46+00:00",
      "product_name": "Example Product Name",
      "product_id": 123456,
      "status": "INCOMPLETE",
      "price": "1.20",
      "customer_email": "[email protected]",
      "ip": "1.1.1.1",
      "first_name": "Joe",
      "last_name": "Smith",
      "affiliate_commission": "0.01",
      "affiliate_commission_status": "PAID",
      "affiliate_id": 2,
      "affiliate_name": "Mary Jane"
    }
  ]
}

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success",
      "detail": null
    },
    "results_count": 3,
    "api_version": "2.0"
  },
  "results": [
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "date": "2016-12-02T12:50:30+00:00",
      "product_name": "Example Product Name",
      "product_id": 123456,
      "status": "COMPLETED",
      "price": "27.00",
      "customer_email": "[email protected]",
      "ip": "1.1.1.1",
      "first_name": "Joe",
      "last_name": "Le Feuvre",
      "affiliate_id": 1,
      "affiliate_name": "John Doe"
    },
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "date": "2016-12-02T12:51:29+00:00",
      "product_name": "Example Product Name",
      "product_id": 123456,
      "status": "COMPLETED",
      "price": "17.00",
      "customer_email": "[email protected]",
      "ip": "1.1.1.1",
      "first_name": "Joe",
      "last_name": "Smith",
      "affiliate_id": 2,
      "affiliate_name": "Mary Doe"
    },
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "date": "2016-12-02T12:51:55+00:00",
      "product_name": "Example Product Name",
      "product_id": 123456,
      "status": "COMPLETED",
      "price": "37.00",
      "customer_email": "[email protected]",
      "ip": "1.1.1.1",
      "first_name": "Joe",
      "last_name": "Smith",
      "affiliate_id": 3,
      "affiliate_name": "Sue Bates"
    }
  ]
}