Rolul API2 este de a pune la dispoziția clienților serviciile Green Mail, astfel încât să le poată accesa de oriunde. Majoritatea funcționalităților portalului Green Mail sunt implementate prin API2. Comparativ cu API1 anterior, aduce mai multe îmbunătățiri semnificative. În plus față de extinderea numărului de servicii, unul dintre cele mai importante este capacitatea de a apela un serviciu web atât prin SOAP, cât și într-un mod REST.
Documentația REST pentru accesul la servicii poate fi găsită la zelenaposta.docs.apiary.io. Pe acest site web este posibil să vedeți solicitările și răspunsurile individuale la acestea în format JSON. De asemenea, puteți testa servicii individuale direct de pe acest site web pe mediul de dezvoltare Green Mail.
Documentația accesului SOAP la servicii poate fi găsită direct pe site-ul Green Mail.
Autentificare
Majoritatea metodelor necesită să vă conectați ca cont de utilizator. Autentificarea poate fi efectuată la nivelul HTTP sau la nivelul cererii SOAP în cazul apelurilor de serviciu de tip SOAP.
Autentificare HTTP
Autentificarea HTTP poate fi utilizată pentru ambele apeluri de serviciu. La apelarea serviciilor de tip REST, autentificarea HTTP este singura opțiune de autentificare. API-ul SOAP acceptă și alte metode de autentificare. Când se utilizează autentificarea HTTP, se utilizează antetul de autorizare HTTP .
Vă puteți autentifica prin două metode:
autentificare de bază cu schema de autentificare de bază. Dacă de ex. Numele de utilizator și parola lui Aladdin sunt OpenSesame, deci un antet este trimis în formularul:
unde șirul QWxhZGRpbjpPcGVuU2VzYW1l a fost creat prin codarea bazei64 șirul Aladdin: OpenSesame (adică codul base64 („$ nume de utilizator: $ parolă”)).
Autentificare token cu schemă de autentificare token .
Autentificare OAuth 2.0
De asemenea, este posibil să utilizați autentificarea OAuth 2.0, atunci când vă conectați utilizând un simbol de acces. Jetonul poate fi obținut folosind serviciul api/2/oauth. Procedura este după cum urmează:
- Se va utiliza adresa https://www.zelenaposta.sk/oauth/request-token?client_id=[clientId]&redirect_uri=[redirectUrl], unde [clientId] este identificatorul clientului aplicației și [redirectUrl] este returnarea adresa la care se returnează. Exemplu dacă [clientId] = 123456 și [redirectUrl] = https://yourwebsite.com deci, adresa rezultată arată astfel: https://www.zelenaposta.sk/oauth/request-token?client_id=123456&redirect_uri=https% 3A% 2F% 2Fww.yourwebsite.com% 2F .
Nu uitați să codificați valoarea [redirectUrl] astfel încât să îndeplinească condițiile formatului URL al șirului de interogare (în PHP metoda urlencode ()), adică. caractere speciale înlocuite cu rambursări procentuale etc.
Vizitând adresa, utilizatorul va fi solicitat să se conecteze la sistemul Green Mail. Când se conectează (sau este deja conectat), i se afișează o pagină unde poate permite aplicației să-și acceseze datele în sistemul Green Mail.
După aprobare, utilizatorul este returnat la [redirectUrl] specificat, jetonul de cerere fiind returnat ca unul dintre parametrii GET. Prin urmare, adresa URL de returnare arată de ex. după cum urmează: https://www.yourwebsite.com/?code=13b435432483b199961bc6cdc063e5d3c93a06a9 .
Cu acest simbol, este posibil să creați un simbol de acces folosind metoda getAccessToken în api/2/oauth .
După crearea jetonului de acces, este posibil să vă conectați la serviciile Green Mail după cum urmează: