Gestione subaccounts

danger

Attenzione: Le api rivenditore sono accessibili solo esclusivamente da indiritto https://NOMERIVENDITORE.web-servizi.net

Usare accesso come rivenditore. non è consentito usare accesso subaccount con chiave rivenditore.

Lista subaccounts

GET /api/rest/v1/users/subaccounts.[json|xml]

Parametri

Parametro	Tipo	Default	Descrizione
limit	number	100	Limita il numero di risultati. Max: 1000
offset	number	0	Offset per la paginazione

Esempio risposta

JSON

{
  "count": 1,
  "limit": 10,
  "offset": 0,
  "subaccounts": [
    // subaccount 1
    {
      "id": "666",
      "username": "subaccount1",
      "email": "email@email.it",
      "created": "2020-08-10 07:07:30",
      "modified": "2020-08-10 07:08:54"
    }
  ]
}

Dettaglio di un subaccount

GET /api/rest/v1/users/subaccounts/:id.[json|xml]

Parametri

Parametro	Tipo	Obbligatorio	Descrizione
id	number	Sì	ID del subaccount

Esempio risposta

JSON

{
  "subaccount": {
    "id": "1942",
    "username": "sub41",
    "email": "sub41@gmail.com",
    "gender": null,
    "lastname": "",
    "firstname": "",
    "date_born": null,
    "wallet": 8,
    "created": "2023-03-03 18:32:11",
    "modified": "2023-03-03 18:32:11"
  }
}

info

Per visualizzare il credito di più utenti usare api wallet

Creare un subaccount

POST /api/rest/v1/users/subaccounts.[json|xml]

Parametri

Parametro	Tipo	Obbligatorio	NULL?	Default	Descrizione
data.username	string	Sì			Username con cui viene identificato il subaccount
data.email	string	Sì			Email subaccount
data.password	string	Sì			Password, minimo 5 caratteri. Non sono consentite password con ripetizioni come 12345
data.gender	enum		Sì	null	Genere dell'utente. Valori possibili: M, F
data.date_born	date		Sì	null	Data formato YYYY-MM-DD
data.lastname	string
data.firstname	string

Esempio richiesta

{
  "data": {
    "username": "subaccount1",
    "email": "subaccount1@gmail.com",
    "password": "password"
  }
}

Errori possibili

• missing_data: Dati mancanti, controllare corpo della richiesta.
• invalid_data: Dati non validi, controllare corpo della richiesta. 1

Note:

• 1 - In alcuni casi viene restituito validationErrors che contiene gli errori di validazione, esempio:

{
    "error": "invalid_data",
    "validation_errors": {
        "username": [
            "Nome utente esistente."
        ],
        "password": [
            "La password deve essere di almeno 5 caratteri."
        ],
        "email": [
            "Email esistente."
        ]
    }
}

Eliminare un subaccount

DELETE /api/rest/v1/users/subaccounts/:id.[json|xml]

Parametri

Parametro	Tipo	Obbligatorio	Descrizione
id	number	Sì	ID del subaccount

Esempio risposta

JSON

{
  "deleted": true
}