REST API – WEDOS.protection Členové

WEDOS REST API je stále ve vývoji. Přístup a funkce se mohou bez předchozího upozornění změnit.

Tento článek částečně popisuje endpoint WEDOS.protection ve WEDOS REST API. Domény WEDOS.protection a služby mají vlastní články. Pro WEDOS API (WAPI) viz WAPI – WEDOS Protection.

Základní informace o WEDOS REST API najdete v článku WEDOS REST API Manuál.

V tomto článku najdete následující informace:

Přístup k WGP endpointu

WGP HTTP REST API v2 slouží ke správě domén, služeb a pozvánek ke spolusprávě ve WEDOS.protection (WGP).

Základní URL a autentizace

Základní URL pro WGP endpointy je: https://api.wedos.com/v2

Autentizace probíhá pouze přes OAuth2: do hlavičky požadavku vložte platný přístupový token (Authorization: Bearer <TOKEN>) se scope wgp . Bez platného tokenu vrací API chybu 2000.

Můžete přidat parametr example=1 ke kterémukoli endpointu jako GET parametr (?example=1 u endpointů bez vlastních GET parametrů, jinak &example=1). API pak pro dané volání vrátí ukázkový příkaz curl bez nutnosti zadávat skutečné parametry. I v tomto režimu je vyžadována platná autentizace.

Přehled endpointů

MetodaEndpointPopis
POST/membersVytvoření pozvánky ke spolusprávě domény
GET/members/{email}Zobrazení pozvánky ke spolusprávě
DELETE/members/{email}Smazání pozvánky ke spolusprávě

Formát odpovědi

Odpovědí API je vždy objekt JSON s klíči code (návratový kód), msg (textový popis), request_id (identifikátor požadavku) a případně data (vrácená data při úspěchu).

Obecné návratové kódy platné pro všechny endpointy (REST vrstva, nezávisle na konkrétní operaci):

  • 1000 – úspěch (OK)
  • 2000 – chybí nebo je neplatná autentizace (OAuth2 Bearer token)
  • 2004 – překročena maximální velikost požadavku (URL nebo tělo požadavku)
  • 4000 – neznámá/nepodporovaná metoda API (volaná kombinace HTTP metody a cesty neexistuje)
  • 4001 – validace vstupních dat selhala
  • 4005 – pro aktuální endpoint v režimu example=1 není k dispozici žádný příklad
  • 6000 – interní chyba při inicializaci podkladového příkazu WAPI

Každý endpoint navíc vrací vlastní business kódy specifické pro danou operaci (odpovídající podkladovému příkazu WAPI). Ty jsou uvedeny v části Návratové kódy u každého endpointu.

POST /members

Vytvoří pozvánku ke spolusprávě jedné nebo více domén WGP pro zadanou e-mailovou adresu.

Parametry:

  • email – povinný – e-mailová adresa, pro kterou se pozvánka vytváří
  • policies – povinný, objekt – asociativní pole ve tvaru {domain or "*" (all domains) => 0/1}, např. {"domain1.tld":1} nebo {"*":1}; nejde o prosté pole názvů domén

Návratové kódy:

  • 1000 – OK
  • 2223 – neplatný formát nebo neexistující e-mailová adresa
  • 2419 – pozvánka nenalezena
  • 2420 – neplatné pole pravidel/podmínek domén (policies)
  • 2424 – členství již existuje
  • 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

  • email – e-mailová adresa pozvánky
  • url – URL pro potvrzení pozvánky
  • policies_count – počet zadaných pravidel

Příklad:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/members' \
  --data '{"email":"esmeralda@wedos.com","policies":{"domain1.tld":1}}'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "email": "esmeralda@wedos.com",
    "url": "https://wgp.wedos.com/invite/abc123def456",
    "policies_count": 1
  }
}

GET /members/{email}

Zobrazí existující pozvánku ke spolusprávě domény pro zadanou e-mailovou adresu.

Parametry:

  • email – povinný, path, URL-encoded (např. %40 pro @) – e-mailová adresa pozvánky

Návratové kódy:

  • 1000 – OK
  • 2223 – neplatný formát nebo neexistující e-mailová adresa
  • 2419 – pozvánka nenalezena
  • 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

  • email – e-mailová adresa pozvánky
  • url – URL pro potvrzení pozvánky
  • policies_count – počet zadaných pravidel

Příklad:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/members/esmeralda%40wedos.com'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "email": "esmeralda@wedos.com",
    "url": "https://wgp.wedos.com/invite/abc123def456",
    "policies_count": 1
  }
}

DELETE /members/{email}

Smaže existující pozvánku ke spolusprávě domény pro zadanou e-mailovou adresu.

Parametry:

  • email – povinný, path, URL-encoded – e-mailová adresa pozvánky

Návratové kódy:

  • 1000 – OK
  • 2223 – neplatný formát nebo neexistující e-mailová adresa
  • 2419 – pozvánka nenalezena
  • 2400 – interní chyba – neregistrovaný návratový kód

Data odpovědi:

  • email – e-mailová adresa smazané pozvánky

Příklad:

curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/members/esmeralda%40wedos.com'
{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "email": "esmeralda%40wedos.com"
  }
}

Poznámky

  • Ani POST /members, ani GET /members/{email} nikdy nevrací v odpovědi obsah zadaných policies – pouze email, url a policies_count. Jde o chování externí administrace WGP, nikoli o omezení této REST vrstvy.

Bylo to užitečné?

Děkujeme za zpětnou vazbu!
Obecné selektory
Pouze přesné shody
Hledat v názvu
Hledat v obsahu
Selektory typů příspěvků
Obsah článku
Procházet kategorie