Az API2 feladata, hogy a Green Mail szolgáltatásokat elérhetővé tegye az ügyfelek számára, hogy bárhonnan hozzáférhessenek hozzájuk. A Green Mail portál legtöbb funkciója az API2-n keresztül valósul meg. A korábbi API1-hez képest számos jelentős fejlesztést hoz. A szolgáltatások számának bővítése mellett a legfontosabb az a képesség, hogy web-szolgáltatást hívjunk SOAP-on és REST-szerűen keresztül.
A szolgáltatásokhoz való hozzáférés REST dokumentációja megtalálható a zelenaposta.docs.apiary.io oldalon. Ezen a weboldalon megtekinthetők az egyedi kérések és azokra adott válaszok JSON formátumban. Az egyes szolgáltatásokat közvetlenül ezen a weboldalon is tesztelheti a Green Mail fejlesztői környezetben.
A szolgáltatásokhoz való SOAP-hozzáférés dokumentációja közvetlenül a Green Mail weboldalon található.
Hitelesítés
A legtöbb módszer megköveteli, hogy felhasználói fiókkal jelentkezzen be. A hitelesítés elvégezhető HTTP-szinten, vagy SOAP-kérelem szintjén SOAP-szerű szolgáltatáshívások esetén.
HTTP hitelesítés
A HTTP-hitelesítés mindkét szervizhíváshoz használható. A REST-szerű szolgáltatások hívásakor a HTTP-hitelesítés az egyetlen hitelesítési lehetőség. A SOAP API más hitelesítési módszereket is támogat. HTTP-hitelesítés használatakor a HTTP-hitelesítés fejléc kerül felhasználásra .
Két módszerrel hitelesíthet:
alap hitelesítés az alap hitelesítési sémával. Ha pl. Aladdin felhasználóneve és jelszava OpenSesame, ezért a fejléc a következő formában kerül elküldésre:
ahol a QWxhZGRpbjpPcGVuU2VzYW1l karakterláncot az Aladdin: OpenSesame (azaz base64encode ("$ felhasználónév: $ password") karakterlánc base64 kódolásával hozták létre.
Token hitelesítés Token hitelesítési sémával .
OAuth 2.0 hitelesítés
Lehetőség van OAuth 2.0 hitelesítés használatára is, ha belép egy hozzáférési jogkivonattal. A token az api/2/oauth szolgáltatás használatával szerezhető be. Az eljárás a következő:
- A https://www.zelenaposta.sk/oauth/request-token?client_id=[clientId]&redirect_uri=[redirectUrl] címet fogjuk használni, ahol az [clientId] az alkalmazás kliens azonosítója, a [redirectUrl] pedig a visszatérés cím, amelyre visszatér. Példa, ha [clientId] = 123456 és [redirectUrl] = https://sajatwebhely.com így van, a kapott cím így néz ki: https://www.zelenaposta.sk/oauth/request-token?client_id=123456&redirect_uri=https% 3A% 2F% 2Fwww.sajatwebhely.com% 2F .
Ne felejtse el kódolni az [redirectUrl] értéket, hogy az megfeleljen a lekérdezési karakterlánc URL-formátumának (PHP-ben az urlencode () metódus) feltételeinek, azaz. speciális karakterek helyébe százalékos visszatérítés stb.
A cím meglátogatásával a felhasználót arra kell kérni, hogy jelentkezzen be a Green Mail rendszerbe. Amikor bejelentkezik (vagy már be van jelentkezve), megjelenik egy oldal, ahol engedélyezheti az alkalmazás számára, hogy hozzáférjen az adataihoz a Green Mail rendszerben.
A jóváhagyást követően a felhasználó visszatér a megadott [redirectUrl] -hez, a kérési tokent pedig a GET paraméterek egyikeként adják vissza. A visszatérő URL ezért pl. az alábbiak szerint: https://www.yourwebsite.com/?code=13b435432483b199961bc6cdc063e5d3c93a06a9 .
Ezzel a tokennel ezután lehetőség van hozzáférési token létrehozására a módszer segítségével getAccessToken az api/2/oauth-ban .
Hozzáférési token létrehozása után a következőképpen lehet bejelentkezni a Green Mail szolgáltatásba: