Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
Obě strany předchozí revize Předchozí verze Následující verze | Předchozí verze Následující verze Obě strany příští revize | ||
cs:tcs-api-documentation.html [2018/06/11 14:03] dans@cesnet.cz [Funkce] |
cs:tcs-api-documentation.html [2018/08/07 14:22] dans@cesnet.cz [Obecný popis volání funkcí API] |
||
---|---|---|---|
Řádek 2: | Řádek 2: | ||
Od **1. 7. 2018** je možné požádat o **serverový certifikát TCS** prostřednictvím API rozhraní. O jiné, než serverové certifikáty přes toto rozhraní žádat **nelze**. | Od **1. 7. 2018** je možné požádat o **serverový certifikát TCS** prostřednictvím API rozhraní. O jiné, než serverové certifikáty přes toto rozhraní žádat **nelze**. | ||
- | |||
- | <WRAP alert> | ||
- | **Upozornění:** Tento návod se vztahuje ke službě, která dosud není aktivní a je prozatím určen pouze pro přípravu v budoucnu napojených systémů klientů. | ||
- | Nepokoušejte se prosím připojit k popisovanému API před datem spuštění, tj. **1. 7. 2018**. API je připravováno na jiném serveru a k jeho překlopení dojde až prvního července. | ||
- | </WRAP> | ||
===== Dokumentace API ===== | ===== Dokumentace API ===== | ||
Řádek 17: | Řádek 12: | ||
Základní adresa pro volání aktuální verze API je | Základní adresa pro volání aktuální verze API je | ||
- | ''%%https://tcs-dev.cesnet.cz/api/v2/certificate/<jméno_funkce>%%'' | + | ''%%https://tcs.cesnet.cz/api/v2/certificate/<jméno_funkce>%%'' |
Podle typu funkce je nutné odeslat požadavek jako **GET**, **POST**, **PUT**, nebo **DELETE**. Momentálně nejsou všechny z těchto typů požadavků rozhraním využity, funkce ale budou v budoucnu rozšiřovány a mohou být využity i dosud nevyužité typy volání rozhraní. | Podle typu funkce je nutné odeslat požadavek jako **GET**, **POST**, **PUT**, nebo **DELETE**. Momentálně nejsou všechny z těchto typů požadavků rozhraním využity, funkce ale budou v budoucnu rozšiřovány a mohou být využity i dosud nevyužité typy volání rozhraní. | ||
Řádek 63: | Řádek 58: | ||
^Klíč ^Uvedení ^Popis ^Povolené hodnoty / Příklad ^Implicitní hodnota ^ | ^Klíč ^Uvedení ^Popis ^Povolené hodnoty / Příklad ^Implicitní hodnota ^ | ||
- | | **certificateRequest** | povinné | žádost o certifikát \\ v BASE64 kódovaném formátu PKCS10 \\ (formát PEM) | -----BEGIN CERTIFICATE REQUEST----- \\ ... \\ -----END CERTIFICATE REQUEST----- | - | | + | | **certificateRequest** | povinné | žádost o certifikát \\ v BASE64 kódovaném formátu \\ PKCS10 (formát PEM) | -----BEGIN CERTIFICATE REQUEST----- \\ ... \\ -----END CERTIFICATE REQUEST----- | - | |
- | | **certificateType** | volitelné | profil (typ) certifikátu | **ov** nebo **es** nebo **ev** \\ (běžné ověření; gridový certifikát; rozšířené ověření) | **ov** | | + | | **certificateType** | volitelné | profil (typ) certifikátu | **ov** nebo **es** nebo **ev** \\ (běžné ověření; \\ gridový certifikát; \\ rozšířené ověření) | **ov** | |
| **certificateValidity** | volitelné | doba platnosti certifikátu [roky] | **1** nebo **2** | **1** | | | **certificateValidity** | volitelné | doba platnosti certifikátu [roky] | **1** nebo **2** | **1** | | ||
| **subjectLanguage** | volitelné | jazyková verze jména organizace \\ v předmětu certifikátu | **cs** nebo **en** nebo **ac** \\ (česká; anglická; ASCII) | **cs** | | | **subjectLanguage** | volitelné | jazyková verze jména organizace \\ v předmětu certifikátu | **cs** nebo **en** nebo **ac** \\ (česká; anglická; ASCII) | **cs** | | ||
Řádek 144: | Řádek 139: | ||
Požadavek: | Požadavek: | ||
<code> | <code> | ||
- | GET /api/v2/certificate/request/1527791390 HTTP/1.1 | + | GET /api/v2/certificate/status/1527791390 HTTP/1.1 |
Host: tcs.cesnet.cz | Host: tcs.cesnet.cz | ||
</code> | </code> |