"We are revamping our Knowledge Base articles to serve you better. In case you find something unusual, do not panic. Reach out to our Support Team by submitting a ticket if you ever need some help.”

Dropfunnel API Documentation

1. Authentication -
For authenticating yourself against the Dropfunnel API you just need to pass the 'username' and 'password' credentials, that you usually use into the Loggin process of the Dropfunnel system into the API request.

URL - https://dropfunnels.com/wp-json/api/v1/autheticate
Method - POST
Parameters - username, password

In addition, to check the user credentials, we are checking the "users subscription" related to dropfunnel system, which means in order to get authenticated successfully user accounts need to have an "Active" subscription on the Dropfunnel system.

Response -
1. If the user passed valid credentials and having an active subscription then, the following response is passed in JSON format
{
'status' : 'success'
'user_details' : {
'ID' => {user_id},
'user_login' => 'user_login_name',
'user_nicename' => {user_nicename},
'user_email' => {user_email}
}
}

2. If the user passed invalid credentials then, the following response is passed in JSON format
{
'status' : 'failure'
'user_details': "Your credential does not match with dropfunnel. Please provide valid credentials."
}

3. If the user is having an inactive subscription -
{
'status' : 'failure'
'user_details': "Your account does not have the active subscription on dropfunnels. Please check your subscription."
}

#Comman paramters to get any data -

1. zap_id - We need 'zap_id' to get the response according to the ZAP that the user has created.
2. is_loading_sample - We need 'is_loading_sample' to check whether the current API call is testing API call OR not. If the current API call is testing API call then we have passed the testing response object.
3. secret_key - A parameter 'secret_key' is used for related to which user we need to send the data. Each and every user has to have a unique API key generated whenever the user wanted to use it.

2. Leads -
In this API endpoint, we are providing a list of the leads that are getting added to the user's account from their funnels. We are going to provide each detail regarding leads in a single lead. We have added the limitation on sending the leads list i.e in a single API call we have to send only 10 Leads.

URL - https://dropfunnels.com/wp-json/api/v1/get-leads
Method - POST
Parameters - zap_id, is_loading_sample, secret_key

3. All orders -
In this API endpoint, we are providing a list of all orders that are getting added to the user's account from their checkout funnels pages. In this API endpoint also, we are going to provide each detail regarding orders in the single order detail. Also, we have added the limitation on sending the orders list i.e in one API call we have to send only 10 orders.

URL - https://dropfunnels.com/wp-json/api/v1/get-all-orders
Method - POST
Parameters - zap_id, is_loading_sample, secret_key

4. Main product orders -
In this API endpoint, we are providing a list of all orders which are placed on the "Main product" purchase that are getting added to the user's account from their checkout funnels pages. Also, we have added the limitation on sending the 'Main product orders' list i.e in one API call we have to send only 10 orders.

URL - https://dropfunnels.com/wp-json/api/v1/get-main-product-orders
Method - POST
Parameters - zap_id, is_loading_sample, secret_key

5. Order bump orders -
In this API endpoint, we are providing a list of all orders which are placed as the "Order bump" purchase that are getting added to the user's account from their checkout funnels pages. Also, we have added the limitation on sending the 'order bump' list i.e in one API call we have to send only 10 orders.

URL - https://dropfunnels.com/wp-json/api/v1/get-order-bump-orders
Method - POST
Parameters - zap_id, is_loading_sample, secret_key

6. Upsell downsell orders
In this API endpoint, we are providing a list of all orders which are placed as the "Upsell / Downsell" purchase that are getting added to the user's account from their checkout funnels pages. Also, we have added the limitation on sending the 'Upsell downsell orders' list i.e in one API call we have to send only 10 orders.

URL - https://dropfunnels.com/wp-json/api/v1/get-upsell-downsell-orders
Method - POST
Parameters - zap_id, is_loading_sample, secret_key

7. Membership -
In this API endpoint, we are providing a list of all memberships which are added regarding various funnels into the user's account from their checkout funnels pages. Also, we have added the limitation on sending the 'memberships' list i.e in one API call we have to send only 10 memberships.

URL - https://dropfunnels.com/wp-json/api/v1/get-membership-orders
Method - POST
Parameters - zap_id, is_loading_sample, secret_key