This article deals with WAPI commands related to the WEDOS Global members. A WAPI beállításáról és a gyakori problémák elhárításáról lásd a cikket 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 = az új tag e-mail-címe vagy meglévő WEDOS fiókjának bejelentkezési neve – kötelező
- policies = az összes domainre (*) vagy meghatározott domainekre vonatkozó jogosultságok tömbje; az értékek: 1 = ReadOnly, 0 = teljes hozzáférés. Részletekért lásd a sablont.
Return Values
- 1000 = OK
- 2223 = érvénytelen vagy nem létező e-mail-cím formátum
- 2274 = belső hiba – hiányzó user_id
- 2400 = belső hiba – ismeretlen válaszkód
- 2419 = a meghívó nem található
- 2420 = érvénytelen policy tömb
- 2424 = a tagság már létezik
- 4000 = rendszerhiba
Response Data
- email = a meghívót fogadó e-mail-cím
- url = a meghívó megerősítő URL-címe
- policies_count = az aktivált policyk száma (a rendszer automatikusan elveti az érvénytelen domaineket)
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 = a tag e-mail-címe vagy meglévő WEDOS fiókjának bejelentkezési neve – kötelező
Return Values
- 1000 = OK
- 2223 = érvénytelen vagy nem létező e-mail-cím formátum
- 2274 = belső hiba – hiányzó user_id
- 2400 = belső hiba – ismeretlen válaszkód
- 2419 = a meghívó nem található
- 4000 = rendszerhiba
Response Data
- email = a meghívót fogadó e-mail-cím
- url = a meghívó megerősítő URL-címe
- policies_count = az aktivált policyk száma (a rendszer automatikusan elveti az érvénytelen domaineket)
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 = a tag e-mail-címe vagy meglévő WEDOS fiókjának bejelentkezési neve – kötelező
Return Values
- 1000 = OK
- 2223 = érvénytelen vagy nem létező e-mail-cím formátum
- 2274 = belső hiba – hiányzó user_id
- 2400 = belső hiba – ismeretlen válaszkód
- 2419 = a meghívó nem található
- 4000 = rendszerhiba
Response Data
- email = a tag bejelentkezési e-mail-címe
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)"
}
}
}