Autentizace (KS webAPI): Porovnání verzí
| (Není zobrazeno 5 mezilehlých verzí od stejného uživatele.) | |||
| Řádek 2: | Řádek 2: | ||
Tato metoda musí být nastavena v konfiguračním souboru klienta. | Tato metoda musí být nastavena v konfiguračním souboru klienta. | ||
== | == Autentizace == | ||
<h3>SOAP</h3> | <h3>SOAP</h3> | ||
| Řádek 12: | Řádek 12: | ||
<h3>REST</h3> | <h3>REST</h3> | ||
Požadavek | |||
<ol> | |||
<li> | |||
<b>Zabezpečení protokolu</b> | |||
<p>Všechny dotazy na API musí být zasílány prostřednictvím zabezpečeného protokolu HTTPS.</p> | |||
</li> | |||
<li> | |||
<b>Přístupová oprávnění</b> | |||
<p>Uživatel musí mít povolení k užívání API, které mu uděluje administrátor. K tomu je nezbytné mít vygenerováno jméno a heslo k API.</p> | |||
</li> | |||
<li> | |||
<b>Autentizace</b> | |||
<p>Pro autentizaci je třeba odeslat na adresu <i>.../KSAsServer/WebService/WebAPI/rest/users/authenticate</i> JSON body s údaji <i>"Username"</i> a <i>"Password"</i>. Pokud jsou tyto údaje správné, obdržíte <strong>token</strong>, který je nutný pro používání API po určitou dobu. Token i jeho platnost jsou vráceny v těle odpovědi.</p> | |||
</li> | |||
<li> | |||
<b>Použití tokenu</b> | |||
<p>Při každém volání API ,mimo autentizaci, je třeba zaslat platný token jedním ze dvou způsobů:</p> | |||
<ul class="ulAktualizace"> | |||
<li> | |||
V HEADER | |||
<p> | |||
Plain: <pre>Authorization - eyJ0eXAwibmFtZSI6InBhdmVIuMDGtBE1GxcdkwUuTTLDL4&</pre> | |||
Bearer: <pre>Authorization - Bearer eyJ0eXAwibmFtZSI6InBhdmVIuMDGtBE1GxcdkwUuTTLDL4&</pre> | |||
</p> | |||
</li> | |||
<li> | |||
V URI<br /> | |||
<pre>GET .../KSAsServer/WebService/WebAPI/rest/KmenoveUdaje/Jmeno/Karel?token=eyJ0eXAwibmFtZSI6InBhdmVIuMDGtBE1GxcdkwUuTTLDL4&</pre> | |||
</li> | |||
</ul> | |||
<p>Způsob HEADER je preferován před URI.</p> | |||
</li> | |||
</ol><br /> | |||
<h4>Požadavek</h4> | |||
<pre> | <pre> | ||
POST /KSAsServer/WebService/WebAPI/rest/user/authenticate | POST .../KSAsServer/WebService/WebAPI/rest/user/authenticate | ||
body: | body: | ||
| Řádek 23: | Řádek 60: | ||
</pre> | </pre> | ||
Odpověď | <h4>Odpověď</h4> | ||
<pre> | <pre> | ||
{ | { | ||
Aktuální verze z 10. 3. 2025, 12:00
Pro ověření uživatele se používá UserName autentizace, kdy se předává jméno a heslo uživatele při volání metody webové služby v části ClientCredentials. Tato metoda musí být nastavena v konfiguračním souboru klienta.
Autentizace
SOAP
<security> <message clientCredentialType="UserName" /> </security>
REST
-
Zabezpečení protokolu
Všechny dotazy na API musí být zasílány prostřednictvím zabezpečeného protokolu HTTPS.
-
Přístupová oprávnění
Uživatel musí mít povolení k užívání API, které mu uděluje administrátor. K tomu je nezbytné mít vygenerováno jméno a heslo k API.
-
Autentizace
Pro autentizaci je třeba odeslat na adresu .../KSAsServer/WebService/WebAPI/rest/users/authenticate JSON body s údaji "Username" a "Password". Pokud jsou tyto údaje správné, obdržíte token, který je nutný pro používání API po určitou dobu. Token i jeho platnost jsou vráceny v těle odpovědi.
-
Použití tokenu
Při každém volání API ,mimo autentizaci, je třeba zaslat platný token jedním ze dvou způsobů:
-
V HEADER
Plain:
Authorization - eyJ0eXAwibmFtZSI6InBhdmVIuMDGtBE1GxcdkwUuTTLDL4&
Bearer:Authorization - Bearer eyJ0eXAwibmFtZSI6InBhdmVIuMDGtBE1GxcdkwUuTTLDL4&
-
V URI
GET .../KSAsServer/WebService/WebAPI/rest/KmenoveUdaje/Jmeno/Karel?token=eyJ0eXAwibmFtZSI6InBhdmVIuMDGtBE1GxcdkwUuTTLDL4&
Způsob HEADER je preferován před URI.
-
V HEADER
Požadavek
POST .../KSAsServer/WebService/WebAPI/rest/user/authenticate
body:
{
"Username": "jmeno",
"Password": "heslo"
}
Odpověď
{
"ErrorCode": 0,
"ErrorMessage": null,
"ErrorText": null,
"IsError": false,
"Message": "Created",
"ResponseDatetime": "/Date(1720705997339+0200)/",
"StatusCode": 201,
"Token": "jkdsjflsdfjsdfklsjdflskdfjs.6tQew",
"ValidTo": "/Date(1720715997000+0200)/"
}
