Struttura API

Introduzione​

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.

Aggiungi utenti

 

Parametri

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–

Descrizione

* Questa API consente di creare un nuovo cliente.
* Questa sezione elenca tutti gli endpoint API che possono essere utilizzati per creare, modificare o gestire utenti.

– Per creare un utente, è necessario compilare i dettagli richiesti come nome, email, telefono, ecc.
– Per registrarsi sul nostro sito, scegliere uno dei gateway di pagamento come PayPal, bonifico bancario, ecc.
Una volta completato con successo il pagamento, l’utente sarà registrato con successo.

RICHIESTA 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,
}

Recupera un utente:

– Questa API consente di recuperare e visualizzare un utente specifico tramite ID o email.
– Utilizzando il metodo PUT, verrà mostrata la risposta JSON come di seguito.

RICHIESTA 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,

  }

ELIMINA UTENTE:

– Questa API consente di eliminare un utente.
– Tramite il metodo DELETE, l’utente verrà eliminato e la risposta JSON verrà mostrata come di seguito.

RICHIESTA 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,
 }

Aggiorna un utente:

– Questa API consente di recuperare e visualizzare un utente specifico tramite ID o email.
– Per aggiornare l’utente, utilizzare il metodo GET per recuperare l’elenco degli utenti.

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

Piano Matrice

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

Descrizione:

– Questa API consente di recuperare e visualizzare un piano matrice utilizzando l’ID della matrice.
– L’endpoint dell’elenco dei piani matrice restituisce informazioni sui piani ProMLM offerti in una determinata
località.
– La risposta include l’ID di visualizzazione e altri dettagli sul nome del piano matrice e sull’ID dello sponsor
correlato.

RICHIESTA HTTP:

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

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

RANGO:

Descrizione:

– Questa API consente di ottenere i dettagli del rango di un piano matrice specifico.
– Nelle impostazioni del modulo di rango, gli utenti riceveranno automaticamente un rango come oro, argento, ecc., se
raggiungono gli obiettivi specificati.

RICHIESTA HTTP:

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

 }

CRONOLOGIA DELLE TRANSAZIONI DELL’UTENTE:

– Questa API consente di recuperare e visualizzare la cronologia delle transazioni di un determinato utente.
– Mostra la cronologia delle transazioni dei dettagli del piano matrice passando l’ID della transazione utilizzando il
metodo GET in formato JSON.

RICHIESTA HTTP:

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

RICHIESTA HTTP:

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

Membri Downline:

– Questa API consente di recuperare e visualizzare gli utenti membri della downline.
– Lo sponsor riceve benefici dalle commissioni PV e GPV per tutti gli utenti downline in base alla matrix_id.

RICHIESTA HTTP:

 {
    "members_id": 1,
    "members_children": "demouser",
    "level": "1",
    "matrix_id": 1,
    "package_id": 2
  }
Torna in alto