This article deals with WAPI commands related to the WEDOS Global members. Per informazioni su come configurare WAPI e risolvere i problemi più comuni, consulta l’articolo WAPI – Manual.
This article provides information on the following requests:
wg-members-create
Use the wgp-members-create command to send an invitation to a new member.
Parameters
- email = indirizzo e-mail del nuovo membro o login di un account WEDOS esistente – obbligatorio
- policies = array dei permessi per tutti i domini (*) o per domini specifici; i valori sono 1 per ReadOnly, 0 per accesso completo. Per i dettagli consulta il template.
Return Values
- 1000 = OK
- 2223 = formato e-mail non valido o indirizzo inesistente
- 2274 = errore interno – user_id mancante
- 2400 = errore interno – codice di risposta sconosciuto
- 2419 = invito non trovato
- 2420 = array di policy non valido
- 2424 = l’appartenenza esiste già
- 4000 = errore di sistema
Response Data
- email = e-mail che riceve l’invito
- url = indirizzo URL di conferma dell’invito
- policies_count = numero di policy attivate (il sistema elimina automaticamente i domini non validi)
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-create",
"clTRID": "your ID",
"data": {
"email": "new member email (WEDOS account login)",
"policies": {
"domain01.tld": "0|1",
"domain02.tld": "0|1",
"*": "0|1"
}
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wg-members-create",
"data": {
"email": "new member email (WEDOS account login)",
"url": "invitation url",
"policies_count": "number of successfully activated policies"
}
}
}
wg-members-show
Use the wgp-members-show return’s a member’s invitation URL.
Parameters
- email = indirizzo e-mail del membro o login di un account WEDOS esistente – obbligatorio
Return Values
- 1000 = OK
- 2223 = formato e-mail non valido o indirizzo inesistente
- 2274 = errore interno – user_id mancante
- 2400 = errore interno – codice di risposta sconosciuto
- 2419 = invito non trovato
- 4000 = errore di sistema
Response Data
- email = e-mail che riceve l’invito
- url = indirizzo URL di conferma dell’invito
- policies_count = numero di policy attivate (il sistema elimina automaticamente i domini non validi)
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-show",
"clTRID": "your ID",
"data": {
"email": "new member email (WEDOS account login)"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wg-members-show",
"data": {
"email": "new member email (WEDOS account login)",
"url": "invitation url",
"policies_count": "number of successfully activated policies"
}
}
}
wg-members-delete
Use the wgp-members-delete to remove an existing member and revoke their permissions.
Parameters
- email = indirizzo e-mail del membro o login di un account WEDOS esistente – obbligatorio
Return Values
- 1000 = OK
- 2223 = formato e-mail non valido o indirizzo inesistente
- 2274 = errore interno – user_id mancante
- 2400 = errore interno – codice di risposta sconosciuto
- 2419 = invito non trovato
- 4000 = errore di sistema
Response Data
- email = e-mail di login del membro
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-delete",
"clTRID": "your ID",
"data": {
"email": "member email (WEDOS account login)"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wg-members-delete",
"data": {
"email": "member email (WEDOS account login)"
}
}
}