Ролята на API2 е да направи услугите на Green Mail достъпни за клиентите, така че те да имат достъп до тях от всяко място. По-голямата част от функционалността на портала Green Mail се реализира чрез API2. В сравнение с предишния API1, той носи няколко значителни подобрения. В допълнение към разширяването на броя на услугите, една от най-важните е възможността за извикване на уеб услуга както чрез SOAP, така и REST-подобен начин.

mail

Документацията за REST за достъп до услуги може да бъде намерена на zelenaposta.docs.apiary.io. На този уебсайт е възможно да видите индивидуални заявки и отговори на тях в JSON формат. Можете също така да тествате отделни услуги директно от този уебсайт в средата за разработка на Green Mail.

Документацията за SOAP достъп до услуги може да бъде намерена директно на уебсайта на Green Mail.

Удостоверяване

Повечето методи изискват да влезете като потребителски акаунт. Удостоверяването може да се извърши на ниво HTTP или на ниво SOAP заявка в случай на повиквания, подобни на SOAP.

HTTP удостоверяване

HTTP удостоверяването може да се използва и за двете повиквания на услуги. Когато се обаждате на REST-подобни услуги, HTTP удостоверяването е единствената опция за удостоверяване. SOAP API поддържа и други методи за удостоверяване. Когато се използва HTTP удостоверяване, се използва заглавката HTTP Authorization .

Можете да удостоверите по два метода:

основно удостоверяване с основната схема за удостоверяване. Ако напр. Потребителското име и парола на Aladdin е OpenSesame, така че се изпраща заглавка във формата:

където низът QWxhZGRpbjpPcGVuU2VzYW1l е създаден чрез base64-кодиране на низа Aladdin: OpenSesame (т.е. base64encode ("$ потребителско име: $ парола")).

Token удостоверяване със схема за удостоверяване на Token .

OAuth 2.0 удостоверяване

Също така е възможно да се използва удостоверяване OAuth 2.0, когато влизате в системата с помощта на маркер за достъп. Токенът може да бъде получен чрез услугата api/2/oauth. Процедурата е следната:

  1. Ще се използва адресът https://www.zelenaposta.sk/oauth/request-token?client_id= [clientId]&redirect_uri= [redirectUrl], където [clientId] е идентификаторът на клиента на приложението, а [redirectUrl] е връща адрес, на който се връща. Пример, ако [clientId] = 123456 и [redirectUrl] = https://yourwebsite.com така, полученият адрес изглежда така: https://www.zelenaposta.sk/oauth/request-token?client_id=123456&redirect_uri=https% 3A% 2F% 2Fwww.yourwebsite.com% 2F .

Не забравяйте да кодирате стойността [redirectUrl], така че да отговаря на условията на URL формата на низа на заявката (в PHP метода urlencode ()), т.е. специални знаци, заменени с процентно възстановяване и т.н.

Посещавайки адреса, потребителят ще бъде подканен да влезе в системата на Green Mail. Когато влезе (или вече е влязъл в системата), му се показва страница, на която той може да разреши на приложението достъп до данните му в системата Green Mail.

След одобрение потребителят се връща към посочения [redirectUrl], докато маркерът на заявката се връща като един от параметрите на GET. Следователно връщащият URL адрес изглежда напр. както следва: https://www.yourwebsite.com/?code=13b435432483b199961bc6cdc063e5d3c93a06a9 .

С този маркер тогава е възможно да се създаде маркер за достъп, използвайки метода getAccessToken в api/2/oauth .

След създаването на маркера за достъп е възможно да влезете в услугите на Green Mail, както следва: