Tento článek se zabývá příkazy WAPI, které souvisejí s členy WEDOS Global. Informace o nastavení WAPI a řešení běžných problémů najdete v článku WAPI – Manuál.
Tento článek popisuje následující požadavky:
wg-members-create
Použijte požadavek wgp-members-create k odeslání pozvánky pro nového člena.
Parametry
- e-mail = e-mailová adresa nového člena nebo přihlašovací jméno stávajícího účtu WEDOS – povinné
- zásady = pole oprávnění pro všechny domény (*) nebo konkrétní domény; hodnota 1 znamená ReadOnly, 0 plný přístup. Podrobnosti viz šablona.
Návratové hodnoty
- 1000 = OK
- 2223 = neplatný formát e-mailu nebo adresa neexistuje
- 2274 = interní chyba – chybí user_id
- 2400 = interní chyba – neznámý návratový kód
- 2419 = pozvánka nenalezena
- 2420 = neplatné pole oprávnění
- 2424 = členství již existuje
- 4000 = systémová chyba
Návratová data
- e-mail = e-mail, na který byla pozvánka odeslána
- url = URL adresa pro potvrzení pozvánky
- policies_count = počet aktivovaných oprávnění (systém automaticky vyřadí neplatné domény)
Šablony
JSON požadavek:
{
"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 odpověď (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
Použijte požadavek wgp-members-show vrátí členovi zvací URL adresu.
Parametry
- e-mail = e-mailová adresa člena nebo přihlašovací jméno stávajícího účtu WEDOS – povinné
Návratové hodnoty
- 1000 = OK
- 2223 = neplatný formát e-mailu nebo adresa neexistuje
- 2274 = interní chyba – chybí user_id
- 2400 = interní chyba – neznámý návratový kód
- 2419 = pozvánka nenalezena
- 4000 = systémová chyba
Návratová data
- e-mail = e-mail, na který byla pozvánka odeslána
- url = URL adresa pro potvrzení pozvánky
- policies_count = počet aktivovaných oprávnění (systém automaticky vyřadí neplatné domény)
Šablony
JSON požadavek:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-show",
"clTRID": "your ID",
"data": {
"email": "new member email (WEDOS account login)"
}
}
}
JSON odpověď (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
Použijte požadavek wgp-members-delete k odebrání stávajícího člena a odvolání jeho oprávnění.
Parametry
- e-mail = e-mailová adresa člena nebo přihlašovací jméno stávajícího účtu WEDOS – povinné
Návratové hodnoty
- 1000 = OK
- 2223 = neplatný formát e-mailu nebo adresa neexistuje
- 2274 = interní chyba – chybí user_id
- 2400 = interní chyba – neznámý návratový kód
- 2419 = pozvánka nenalezena
- 4000 = systémová chyba
Návratová data
- e-mail = přihlašovací e-mail člena
Šablony
JSON požadavek:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-delete",
"clTRID": "your ID",
"data": {
"email": "member email (WEDOS account login)"
}
}
}
JSON odpověď (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)"
}
}
}