WAPI – Členovia WEDOS Global

Tento článok obsahuje informácie o nasledujúcich požiadavkách:

• wg-members-create
• wg-members-show
• wg-members-delete

---

wg-members-create

Použite wgp-members-create na odoslanie pozvánky pre nového člena.

Parametre

• email = e-mailová adresa nového člena alebo prihlasovacie meno existujúceho účtu WEDOS – povinné
• policies = pole oprávnení pre všetky domény (*) alebo konkrétne domény; hodnota 1 znamená ReadOnly, 0 plný prístup. Podrobnosti pozri v šablóne.

Návratové hodnoty

• 1000 = OK
• 2223 = neplatný formát e-mailu alebo adresa neexistuje
• 2274 = interná chyba – chýba user_id
• 2400 = interná chyba – neznámy návratový kód
• 2419 = pozvánka sa nenašla
• 2420 = neplatné pole oprávnení
• 2424 = členstvo už existuje
• 4000 = systémová chyba

Dáta odpovede

• email = e-mail, na ktorý bola pozvánka odoslaná
• url = URL adresa na potvrdenie pozvánky
• policies_count = počet aktivovaných oprávnení (systém automaticky vyradí neplatné domény)

Šablóny

JSON požiadavka:

{
  "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 odpoveď (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žite wgp-members-show vráti členovi pozývaciu URL adresu.

Parametre

• email = e-mailová adresa člena alebo prihlasovacie meno existujúceho účtu WEDOS – povinné

Návratové hodnoty

• 1000 = OK
• 2223 = neplatný formát e-mailu alebo adresa neexistuje
• 2274 = interná chyba – chýba user_id
• 2400 = interná chyba – neznámy návratový kód
• 2419 = pozvánka sa nenašla
• 4000 = systémová chyba

Dáta odpovede

• email = e-mail, na ktorý bola pozvánka odoslaná
• url = URL adresa na potvrdenie pozvánky
• policies_count = počet aktivovaných oprávnení (systém automaticky vyradí neplatné domény)

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-show",
    "clTRID": "your ID",
    "data": {
      "email": "new member email (WEDOS account login)"
    }
  }
}

JSON odpoveď (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žite wgp-members-delete na odstránenie existujúceho člena a odobratie jeho oprávnení.

Parametre

• email = e-mailová adresa člena alebo prihlasovacie meno existujúceho účtu WEDOS – povinné

Návratové hodnoty

• 1000 = OK
• 2223 = neplatný formát e-mailu alebo adresa neexistuje
• 2274 = interná chyba – chýba user_id
• 2400 = interná chyba – neznámy návratový kód
• 2419 = pozvánka sa nenašla
• 4000 = systémová chyba

Dáta odpovede

• email = prihlasovací e-mail člena

Šablóny

JSON požiadavka:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-delete",
    "clTRID": "your ID",
    "data": {
      "email": "member email (WEDOS account login)"
    }
  }
}

JSON odpoveď (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)"
    }
  }
}