API Structure

Introduction

API documentation is a technical content deliverable, containing instructions about how to effectively use and integrate with an API. It’s a concise reference manual containing all the information required to work with the API, with details about the functions, classes, return types, arguments and more, supported by tutorials and examples. API Documentation has traditionally been done using regular content creation and maintenance tools and text editors.

Add users

Parameters

AttributeTypeDescription
members_idintegerUnique identifier for the resource. read-only
usernamestringUsers username
firstnamestringUsers firstname
lastnamestringUsers lastname
emailstringThe email address for the customer. mandatory
passwordstringUsers password. write-only
phoneintegerUser phonenumber
alternateemailstringUsers alternateemail
Dojdate-timeThe date the user was born, as GMT. read-only
addressstringUsers address
address2stringUsers alternate address
address3stringUsers alternate address
citystringUser city
matrix_idinteger
sponsor_idinteger
package_idInteger
date-createddate-time
date-modifieddate-time

Description

* This API helps you to create a new customer.
* This section lists all API endpoints that can be used to create, edit or otherwise manipulate user.

– To create user you have to fill the required details like name,email,phone and etc-.
– To register our site choose any of the payment gateway like paypal, bankwire and etc.
once the payment success the user will be successfully registered HTTP REQUEST:

{
"members_id": 1,
"date_created": "2017-03-21T16:11:14",
"date_modified": "2017-03-21T16:11:16",
"email": "[email protected]",
"firstname": "João",
"lastname": "Silva",
"username": "joao.silva",
"address_1": "Av. Brasil, 432",
"address_2": "",
"city": "Rio de Janeiro",
"state": "RJ",
"postcode": "12345-000",
"country": "BR",
"phone": "(55) 5555-5555",
"matrix_id": 1,
"sponsor_id": demouser,
"package _id": 5,
}

Retrive a user:

– This API lets you retrieve and view a specific user by ID or email.
– By using put method the json response has shown below

HTTP REQUEST:

{
    "members_id": 1,
    "date_created": "2017-03-21T16:11:14",
    "date_modified": "2017-03-21T16:11:16",
    "email": "[email protected]",
    "firstname": "João",
    "lastname": "Silva",
    "username": "joao.silva",
    "address_1": "Av. Brasil, 432",
    "address_2": "",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "postcode": "12345-000",
    "country": "BR",
    "phone": "(55) 5555-5555",
    "matrix_id": 1,
    "sponsor_id": demouser1,
    "package _id": 1,
  }

DELETE USER:

– This API helps you delete a user.
– By passing delete method the can be deleted and json response has shown below HTTP REQUEST:

 {
    "members_id": 1,
    "date_created": "2017-03-21T16:11:14",
    "date_modified": "2017-03-21T16:11:16",
    "email": "[email protected]",
    "firstname": "João",
    "lastname": "Silva",
    "username": "joao.silva",
    "address_1": "Av. Brasil, 432",
    "address_2": "",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "postcode": "12345-000",
    "country": "BR",
    "phone": "(55) 5555-5555"
    "matrix_id": 1,
    "sponsor_id": demouser1,
    "package _id": 1,
 }

Update a user:

– This API lets you retrieve and view a specific user by ID or email.
– To update the user by using get method to retreive the user list in

HTTP REQUEST:

 {
    "members_id": 1,
    "date_created": "2017-03-21T16:11:14",
    "date_modified": "2017-03-21T16:11:16",
    "email": "[email protected]",
    "firstname": "João",
    "lastname": "Silva",
    "username": "joao.silva",
    "address_1": "Av. Brasil, 432",
    "address_2": "",
    "city": "Rio de Janeiro",
    "state": "RJ",
    "postcode": "12345-000",
    "country": "BR",
    "phone": "(55) 5555-5555"
  }

Matrix Plan

AttributeTypeDescription
matrix_idintegerUnique identifier for the resource. read-only
matrix_namestringSet it by admin
direct_idIntegerUnique identifier for the resource. read-only
spillover_idIntegerUnique identifier for the resource. read-only
sponsor_idIntegerUnique identifier for the resource. read-only
package_idintegerUnique identifier for the resource. read-only
package_namestringSet it by admin

 

Description:

– This API lets you retrieve and view a matrix plan by matrix id.
– The matrix plan list endpoint returns information about the promlm plans offered at a given location.
– The response includes the display ID and other details about matrix plan name ,sponsor ID related to the plan


HTTP REQUEST:

 {
    "matrix_id": 1,
    "matrix_name": binary,
    "package_id": 5
  }

[/boc_text_box][/vc_column][/vc_row][vc_row][vc_column][vc_column_text]

RANK:

Desription:

– This API lets you rank details of pariculatar matrix plan.
– In rank modules settings, based on the following parameters like downline count users, target PV, target GPV, group sales, total sales and etc
– user will get assigned rank automatically like gold, silver etc. Users will get assigned these ranking only if they attain the specified target

HTTP REQUEST:

 {
  "rank_id": 1,
  "matrix_id": 5,
  "achieved_date": "2017-09-28T08:21:42.961Z"
 }

TRANSCATION HISTORY OF USER:

– This API lets you retrieve and view a transcation history of particular user.
– Show the transcation history of particular plan matrix details with passing the transcation id by using get method of json response

HTTP REQUEST:

 {
    "history_type": "string",
    "description": "string",
    "wallet_type": "string",
    "matrix_id": "string",
    "achieved_date": "2017-09-28T10:18:31.282Z"
  }
Country:
-- Listed the Countries
AttributeTypeDescription
country_idintegerUnique identifier for the resource. read-only
country_namestringListed the country name

HTTP REQUEST:

 {
    "country_id": 1,
    "country_name": "INDIA"
  }

Downline members:

– This API lets you retrieve and view a downline members users
– Sponsor user added multiple downline user get PV commission get benifit
– Sponsor get benifit of GPV commission of total downline users by matrix_id


HTTP REQUEST:

 {
    "members_id": 1,
    "members_children": "demouser",
    "level": "1",
    "matrix_id": 1,
    "package_id": 2
  }
Scroll to Top