REST API – WEDOS.protection Členovia

WEDOS REST API je stále vo vývoji. Prístup a funkcie sa môžu bez predchádzajúceho upozornenia zmeniť.

Tento článok čiastočne popisuje WEDOS.protection endpoint WEDOS REST API. Domény WEDOS.protection a služby majú vlastné články. Pre WEDOS API (WAPI) pozri WAPI – WEDOS Protection.

Základné informácie o WEDOS REST API nájdete v článku WEDOS REST API Manuál.

V tomto článku nájdete nasledujúce informácie:

Prístup k WGP endpointu

WGP HTTP REST API v2 slúži na správu domén, služieb a pozvánok na spolusprávu vo WEDOS.protection (WGP).

Základné URL a autentizácia

Základné URL pre WGP endpointy je: https://api.wedos.com/v2

Na autentizáciu slúži iba OAuth2: do hlavičky požiadavky vložte platný prístupový token (Authorization: Bearer <TOKEN>) so scope wgp . Bez platného tokenu vracia API chybu 2000.

Môžete pridať parameter example=1 ku ktorémukoľvek endpointu ako GET parameter (?example=1 pre endpointy bez vlastných GET parametrov, inak &example=1). API potom pre dané volanie vráti ukážkový príkaz curl bez nutnosti zadávať skutočné parametre. Aj v tomto režime je vyžadované platné overenie.

Prehľad endpointov

MetódaEndpointPopis
POST/membersVytvorenie pozvánky na spolusprávu domény
GET/members/{email}Zobrazenie pozvánky na spolusprávu
DELETE/members/{email}Zmazanie pozvánky na spolusprávu

Formát odpovede

Odpoveďou API je vždy objekt JSON s kľúčmi code (návratový kód), msg (textový popis), request_id (identifikátor požiadavky) a prípadne data (vrátené dáta pri úspechu).

Všeobecné návratové kódy platné pre všetky endpointy (REST vrstva, nezávisle od konkrétnej operácie):

  • 1000 – úspech (OK)
  • 2000 – chýba alebo je neplatná autentizácia (OAuth2 Bearer token)
  • 2004 – prekročená maximálna veľkosť požiadavky (URL alebo telo požiadavky)
  • 4000 – neznáma/nepodporovaná metóda API (volaná kombinácia HTTP metódy a cesty neexistuje)
  • 4001 – overenie vstupu zlyhalo
  • 4005 – pre aktuálny endpoint nie je v režime example=1 k dispozícii žiadny príklad
  • 6000 – interná chyba pri inicializácii podkladového WAPI príkazu

Každý endpoint navyše vracia vlastné biznis kódy špecifické pre danú operáciu (zodpovedajúce podkladovému WAPI príkazu). Tie sú uvedené v časti Návratové kódy pri každom endpointe.

POST /members

Vytvorí pozvánku na spolusprávu jednej alebo viacerých domén WGP pre zadanú e-mailovú adresu.

Parametre:

  • email – povinný – e-mailová adresa, pre ktorú sa pozvánka vytvára
  • policies – povinný, objekt – asociatívne pole v tvare {domain or "*" (all domains) => 0/1}, napr. {"domain1.tld":1} alebo {"*":1}; nejde o obyčajné pole názvov domén

Návratové kódy:

  • 1000 – OK
  • 2223 – neplatný formát alebo neexistujúca e-mailová adresa
  • 2419 – pozvánka nenájdená
  • 2420 – neplatné pole pravidiel/podmienok domén (policies)
  • 2424 – členstvo už existuje
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • email – e-mailová adresa pozvánky
  • url – URL na potvrdenie pozvánky
  • policies_count – počet zadaných pravidiel

Prí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úcu pozvánku na spolusprávu domény pre zadanú e-mailovú adresu.

Parametre:

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

Návratové kódy:

  • 1000 – OK
  • 2223 – neplatný formát alebo neexistujúca e-mailová adresa
  • 2419 – pozvánka nenájdená
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • email – e-mailová adresa pozvánky
  • url – URL na potvrdenie pozvánky
  • policies_count – počet zadaných pravidiel

Prí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}

Zmaže existujúcu pozvánku na spolusprávu domény pre zadanú e-mailovú adresu.

Parametre:

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

Návratové kódy:

  • 1000 – OK
  • 2223 – neplatný formát alebo neexistujúca e-mailová adresa
  • 2419 – pozvánka nenájdená
  • 2400 – interná chyba – neregistrovaný návratový kód

Dáta odpovede:

  • email – e-mailová adresa zmazanej pozvánky

Prí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 nevracia vo svojej odpovedi obsah zadaných policies – iba email, url a policies_count. Ide o správanie externej administrácie WGP, nie o obmedzenie tejto REST vrstvy.

Bolo to užitočné?

Ďakujeme za vašu spätnú väzbu!
Všeobecné selektory
Iba presné zhody
Hľadať v názve
Hľadať v obsahu
Selektory typov príspevkov
Obsah článku
Prehliadať kategórie