WAPI – Członkowie WEDOS Global

Ten artykuł zawiera informacje o następujących żądaniach:

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

---

wg-members-create

Użyj polecenia wgp-members-create aby wysłać zaproszenie do nowego członka.

Parametry

• email = adres e-mail nowego członka lub login istniejącego konta WEDOS – wymagane
• policies = tablica uprawnień dla wszystkich domen (*) lub wybranych domen; wartość 1 oznacza ReadOnly, 0 pełny dostęp. Szczegóły w szablonie.

Wartości zwracane

• 1000 = OK
• 2223 = nieprawidłowy format e-maila lub adres nie istnieje
• 2274 = błąd wewnętrzny – brak user_id
• 2400 = błąd wewnętrzny – nieznany kod odpowiedzi
• 2419 = nie znaleziono zaproszenia
• 2420 = nieprawidłowa tablica uprawnień
• 2424 = członkostwo już istnieje
• 4000 = błąd systemu

Dane odpowiedzi

• email = e-mail, na który wysłano zaproszenie
• url = adres URL potwierdzenia zaproszenia
• policies_count = liczba aktywowanych uprawnień (system automatycznie odrzuca nieprawidłowe domeny)

Szablony

Żądanie JSON:

{
  "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"
      }
    }
  }
}

Odpowiedź JSON (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

Użyj polecenia wgp-members-show zwraca członka adres URL zaproszenia.

Parametry

• email = adres e-mail członka lub login istniejącego konta WEDOS – wymagane

Wartości zwracane

• 1000 = OK
• 2223 = nieprawidłowy format e-maila lub adres nie istnieje
• 2274 = błąd wewnętrzny – brak user_id
• 2400 = błąd wewnętrzny – nieznany kod odpowiedzi
• 2419 = nie znaleziono zaproszenia
• 4000 = błąd systemu

Dane odpowiedzi

• email = e-mail, na który wysłano zaproszenie
• url = adres URL potwierdzenia zaproszenia
• policies_count = liczba aktywowanych uprawnień (system automatycznie odrzuca nieprawidłowe domeny)

Szablony

Żądanie JSON:

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

Odpowiedź JSON (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

Użyj polecenia wgp-members-delete aby usunąć istniejącego członka i odebrać mu uprawnienia.

Parametry

• email = adres e-mail członka lub login istniejącego konta WEDOS – wymagane

Wartości zwracane

• 1000 = OK
• 2223 = nieprawidłowy format e-maila lub adres nie istnieje
• 2274 = błąd wewnętrzny – brak user_id
• 2400 = błąd wewnętrzny – nieznany kod odpowiedzi
• 2419 = nie znaleziono zaproszenia
• 4000 = błąd systemu

Dane odpowiedzi

• email = e-mail logowania członka

Szablony

Żądanie JSON:

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

Odpowiedź JSON (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)"
    }
  }
}