/api/2/oauth

/api/2/oauth

Táto služba umožňuje narábať s vlastnými aplikáciami využívajúcimi Zelenú poštu a autentifikovať používateľa prostredníctvom Zelenej pošty vo vlastných aplikáciách.

createApplication

Metóda createApplication vytvorí vlastnú aplikáciu využívajúcu Zelenú poštu. Aplikácia bude mať vlastné meno (treba zadať unikátne), klientský identifikátor, prístupové tajomstvo a číselný identifikátor. Následne sa dajú vytvárať pre danú aplikáciu prístupové tokeny pre používateľov.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
       <createApplicationRequest xmlns="http://schemas.zelenaposta.sk/oauth">
            <applicationName>[string?]</applicationName>
        </createApplicationRequest>
    </Body>
</Envelope>
Názov parametru Popis
applicationName Unikátny názov aplikácie, ktorý bude použitý pre vytvorenú aplikáciu.

Odpoveďou sú údaje o vytvorenej aplikácii.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/oauth">
    <soap:Body>
        <ns6:createApplicationResponse>
            <ns6:application>
                <ns6:id>29</ns6:id>
                <ns6:clientId>d3e636b8ea4f4b5d131d063081a9ad0e0682db27</ns6:clientId>
                <ns6:secret>719dc86cc7545ea4c1952ed1593b23e83f1b89e0</ns6:secret>
                <ns6:name>APLIKACIA</ns6:name>
            </ns6:application>
        </ns6:createApplicationResponse>
    </soap:Body>
</soap:Envelope>
Názov Popis
id Číselný unikátny identifikátor aplikácie.
clientId Prístupový kľúč aplikácie - klientský identifikátor.
secret Prístupové tajomstvo aplikácie.
name Názov aplikácie (bol zadaný v requeste).

deleteApplications

Metóda vymaže zadané aplikácie. Požiadavka obsahuje zoznam ID aplikácií, ktoré chceme vymazať.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <deleteApplicationsRequest xmlns="http://schemas.zelenaposta.sk/oauth">
            <applicationIds>
                <applicationId>[int?]</applicationId>
                <applicationId>[int?]</applicationId>
                ...
            </applicationIds>
        </deleteApplicationsRequest>
    </Body>
</Envelope>
Názov parametru Popis
applicationId Číselný identifikátor aplikácie na vymazanie.

Odpoveď je prázdna ak sa podarilo vymazať aplikácie alebo obsahuje chybu ak sa nepodarilo.

getApplication

Metóda getApplication vráti informácie o požadovanej aplikácii.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
       <createApplicationRequest xmlns="http://schemas.zelenaposta.sk/oauth">
            <clientId>[string?]</clientId>
        </createApplicationRequest>
    </Body>
</Envelope>
Názov parametru Popis
clientId Klientský identifikátor aplikácie.

Odpoveďou sú údaje o danej aplikácii.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/oauth">
    <soap:Body>
        <ns6:createApplicationResponse>
            <ns6:application>
                <ns6:id>29</ns6:id>
                <ns6:clientId>d3e636b8ea4f4b5d131d063081a9ad0e0682db27</ns6:clientId>
                <ns6:secret>719dc86cc7545ea4c1952ed1593b23e83f1b89e0</ns6:secret>
                <ns6:name>APLIKACIA</ns6:name>
            </ns6:application>
        </ns6:createApplicationResponse>
    </soap:Body>
</soap:Envelope>
Názov Popis
id Číselný unikátny identifikátor aplikácie.
clientId Prístupový kľúč aplikácie - klientský identifikátor.
secret Prístupové tajomstvo aplikácie.
name Názov aplikácie (bol zadaný v requeste).

getApplications

Metóda getApplications vráti všetky vytvorené aplikácie. Požiadavka neobsahuje žiadne parametre.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getApplicationsRequest xmlns="http://schemas.zelenaposta.sk/oauth"/>
    </Body>
</Envelope>

Odpoveďou je zoznam údajov o všetkých aplikáciách.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/oauth">
    <soap:Body>
        <ns6:getApplicationsResponse>
            <ns6:applications>
                <ns6:application>
                    <ns6:id>24</ns6:id>
                    <ns6:key>2a848d460dd683d9a14d54a4cf56e288675e3ab6</ns6:key>
                    <ns6:secret>a0d737184e5d9cc5277da4156f930a78f2918e05</ns6:secret>
                    <ns6:name>rekt</ns6:name>
                </ns6:application>
                <ns6:application>
                    <ns6:id>27</ns6:id>
                    <ns6:key>21071269ee3f567ff67cc26c80981c5e84f5d4e1</ns6:key>
                    <ns6:secret>26c4c58fea45b9fa2306b9ace8a932c423add7a0</ns6:secret>
                    <ns6:name>APPKA2</ns6:name>
                </ns6:application>
                <ns6:application>
                    <ns6:id>28</ns6:id>
                    <ns6:key>19d74c6c0ca379b9278bb9e3f32e5f6f1123096d</ns6:key>
                    <ns6:secret>965458ee45697eed6d60337394002ae14ef874e8</ns6:secret>
                    <ns6:name>APLIKA1</ns6:name>
                </ns6:application>
            </ns6:applications>
        </ns6:getApplicationsResponse>
    </soap:Body>
</soap:Envelope>

updateApplication

Metóda updateApplication umožňuje zmeniť meno danej aplikácie.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <updateApplicationRequest xmlns="http://schemas.zelenaposta.sk/oauth">
            <id>[int?]</id>
            <applicationName>[string?]</applicationName>
        </updateApplicationRequest>
    </Body>
</Envelope>
Názov Popis
id Číselný unikátny identifikátor aplikácie.
applicationName Nové meno aplikácie.

Odpoveďou je prádzna ak sa podarilo upraviť meno aplikácie, inak je vrátená chyba.

getAccessToken

Metóda getAccessToken vráti prístupový token pre danú aplikáciu a daný požiadavkový token. Použitím tohto sa je možné prihlásiť v službách Zelenej pošty.

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Body>
        <getAccessTokenRequest xmlns="http://schemas.zelenaposta.sk/oauth">
            <requestToken>[string?]</requestToken>
            <clientId>[string?]</clientId>
            <secret>[string?]</secret>
        </getAccessTokenRequest>
    </Body>
</Envelope>
Názov parametru Popis
requestToken Požiadavkový token vygenerovaný metódou getRequestToken.
clientId Klientský identifikátor aplikácie.
secret Prístupové tajomstvo aplikácie.

Odpoveďou je prístupový token a dátum a čas dokedy je platný.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://schemas.zelenaposta.sk/core" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://schemas.zelenaposta.sk/oauth">
    <soap:Body>
        <ns6:getAccessTokenResponse>
            <ns6:accessToken>935d9ff04f8e92c43890b69438b6f91b2005433c</ns6:accessToken>
            <ns6:validTo>2018-09-04T12:45:35Z</ns6:validTo>
        </ns6:getAccessTokenResponse>
    </soap:Body>
</soap:Envelope>
Názov Popis
accessToken Token, ktorým sa je možné prihlasovať v službách Zelenej pošty, má platnosť 60 minút.
validTo Čas a dátum dokedy je token platný.


Dotazy:

info@zelenaposta.cz

Služby API2