Structure de l'API

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.

Ajouter des utilisateurs

Paramètres

Attribute Type Description
members_id integer Unique identifier for the resource. read-only
username string Users username
firstname string Users firstname
lastname string Users lastname
email string The email address for the customer. mandatory
password string Users password. write-only
phone integer User phonenumber
alternateemail string Users alternateemail
Doj date-time The date the user was born, as GMT. read-only
address string Users address
address2 string Users alternate address
address3 string Users alternate address
city string User city
matrix_id integer –
sponsor_id integer –
package_id Integer –
date-created date-time –
date-modified date-time –

Description

* Cette API vous aide à créer un nouveau client.
* Cette section répertorie tous les points de terminaison API pouvant être utilisés pour créer, modifier ou gérer des
utilisateurs.

– Pour créer un utilisateur, vous devez remplir les informations requises telles que nom, e-mail, téléphone, etc.
– Pour vous inscrire sur notre site, choisissez l’une des passerelles de paiement comme PayPal, virement bancaire, etc.
Une fois le paiement réussi, l’utilisateur sera enregistré avec succès.

REQUÊTE HTTP :

{
"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,
}

Récupérer un utilisateur :

– Cette API vous permet de récupérer et d’afficher un utilisateur spécifique par ID ou e-mail.
– En utilisant la méthode PUT, la réponse JSON ci-dessous sera affichée.

REQUÊTE HTTP :

{
    "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,

  }

SUPPRIMER UN UTILISATEUR :

– Cette API vous aide à supprimer un utilisateur.
– En passant par la méthode DELETE, l’utilisateur peut être supprimé et la réponse JSON sera affichée ci-dessous.

REQUÊTE HTTP :

 {
    "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,
 }

Mettre à jour un utilisateur :

– Cette API vous permet de récupérer et d’afficher un utilisateur spécifique par ID ou e-mail.
– Pour mettre à jour l’utilisateur, utilisez la méthode GET pour récupérer la liste des utilisateurs.

REQUÊTE HTTP :

 {
    "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"
  }

Plan Matriciel

Attribute Type Description
matrix_id integer Unique identifier for the resource. read-only
matrix_name string Set it by admin
direct_id Integer Unique identifier for the resource. read-only
spillover_id Integer Unique identifier for the resource. read-only
sponsor_id Integer Unique identifier for the resource. read-only
package_id integer Unique identifier for the resource. read-only
package_name string Set it by admin

Description :

– Cette API vous permet de récupérer et d’afficher un plan matriciel par ID de matrice.
– Le point de terminaison de la liste des plans matriciels renvoie des informations sur les plans ProMLM proposés à un
emplacement donné.
– La réponse inclut l’ID d’affichage et d’autres détails sur le nom du plan matriciel et l’ID du sponsor associé.

REQUÊTE HTTP :

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

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

RANG :

Description :

– Cette API permet d’obtenir les détails du rang d’un plan matriciel spécifique.
– Dans les paramètres du module de rang, les utilisateurs recevront automatiquement un rang tel que or, argent, etc.,
s’ils atteignent les objectifs spécifiés.

REQUÊTE HTTP :

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

 }

HISTORIQUE DES TRANSACTIONS DE L’UTILISATEUR :

– Cette API vous permet de récupérer et d’afficher l’historique des transactions d’un utilisateur spécifique.
– Affiche l’historique des transactions des détails du plan matriciel en transmettant l’ID de transaction à l’aide de la
méthode GET avec réponse JSON.

REQUÊTE HTTP :

 {
    "history_type": "string",
    "description": "string",
    "wallet_type": "string",
    "matrix_id": "string",
    "achieved_date": "2017-09-28T10:18:31.282Z"
  }
Country:
-- Listed the Countries
Attribute Type Description
country_id integer Unique identifier for the resource. read-only
country_name string Listed the country name

HTTP REQUEST:

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

Membres Downline :

– Cette API vous permet de récupérer et d’afficher les membres downline.
– Le sponsor reçoit les avantages des commissions PV et GPV pour tous les utilisateurs downline en fonction de la
matrix_id.

REQUÊTE HTTP :

 {
    "members_id": 1,
    "members_children": "demouser",
    "level": "1",
    "matrix_id": 1,
    "package_id": 2
  }
Retour en haut