API Reference | KUPKAPI

Interaktivní režim je zamčen

Zadejte váš API Key v levém panelu. Odemknete tím testovací konzoli, seznam vašich povolených metod a sledování stavu vašich webhooků v reálném čase přes DMZ-CORE-02.

auth

WSDL

JSON VISUAL

Vstupní parametry

{

"apikey"*:

{ // API KEY

"type": string,
"required": true,
"description": API KEY

}

Struktura odpovědi

{

"status": { // Request status"type": string,
"description": Request status
},
"token": { // JWT Token (HS256)"type": string,
"description": JWT Token (HS256)
},
"expires_at": { // Expiration date and time"type": datetime,
"description": Expiration date and time
},
"type": { // Token type (Bearer)"type": string,
"description": Token type (Bearer)
}

}

AUTENTIZAČNÍ PROTOKOL A HLAVIČKY (REST / SOAP)

Pro tuto metodu (REST i SOAP) postačuje základní autorizace pomocí statického klíče.

X-API-Key: váš_api_klíč

SOAP Poznámka: Endpoint /soap/?module=auth přebírá stejné HTTP hlavičky (X-Api-Key / Authorization) v transportní vrstvě.

METODYHTTP POSTSOAP

CONTENT-TYPEapplication/json / text/xml

Sandbox

{
    "apikey": "string"
}

GET https://api.plzensky-kraj.cz/api/auth/login/json/%7B%22apikey%22%3A%22string%22%7D

curl -X POST https://api.plzensky-kraj.cz/api/auth/login/json -H "Authorization: Bearer TOKEN" -d '{"apikey":"string"}'

using var klient = new HttpClient();
klient.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "TOKEN");

var telo = new StringContent(
    @"{""apikey"":""string""}",
    Encoding.UTF8, "application/json");

var odpoved = await klient.PostAsync("https://api.plzensky-kraj.cz/api/auth/login/json", telo);
odpoved.EnsureSuccessStatusCode();
var json = await odpoved.Content.ReadAsStringAsync();

$hlavicky = @{ Authorization = "Bearer TOKEN" }

$telo = '{"apikey":"string"}'

$odpoved = Invoke-RestMethod -Uri "https://api.plzensky-kraj.cz/api/auth/login/json" `
    -Method Post -Headers $hlavicky `
    -ContentType "application/json; charset=utf-8" -Body $telo

$odpoved | ConvertTo-Json -Depth 10

import requests

telo =  . $e($telo) . 

odpoved = requests.post(
    "https://api.plzensky-kraj.cz/api/auth/login/json",
    headers={
        "Authorization": "Bearer TOKEN",
        "Content-Type": "application/json; charset=utf-8",
    },
    data=telo.encode("utf-8"),
    timeout=30,
)
odpoved.raise_for_status()
data = odpoved.json()

HttpClient klient = HttpClient.newHttpClient();

HttpRequest pozadavek = HttpRequest.newBuilder()
    .uri(URI.create("https://api.plzensky-kraj.cz/api/auth/login/json"))
    .header("Authorization", "Bearer TOKEN")
    .header("Content-Type", "application/json; charset=utf-8")
    .POST(HttpRequest.BodyPublishers.ofString(
        """
        {"apikey":"string"}
        """, StandardCharsets.UTF_8))
    .build();

HttpResponse odpoved = klient.send(
    pozadavek, HttpResponse.BodyHandlers.ofString());

$ch = curl_init("https://api.plzensky-kraj.cz/api/auth/login/json");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => '{"apikey":"string"}',
    CURLOPT_HTTPHEADER     => [
        "Authorization: Bearer TOKEN",
        "Content-Type: application/json; charset=utf-8",
    ],
    CURLOPT_TIMEOUT        => 30,
]);

$odpoved = curl_exec($ch);
$data = json_decode($odpoved, true);

const odpoved = await fetch("https://api.plzensky-kraj.cz/api/auth/login/json", {
    method: "POST",
    headers: {
        "Authorization": "Bearer TOKEN",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({"apikey":"string"}),
});

if (!odpoved.ok) throw new Error("HTTP " + odpoved.status);
const data = await odpoved.json();

Klíč se dosadí z levého panelu. Posílá se v hlavičce Authorization, ne v adrese – v logu serveru pak nezůstane.

Endpoint: https://api.plzensky-kraj.cz/soap/?module=auth

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://schema.kupk.cz/api/">
   <soapenv:Header/>
   <soapenv:Body>
      <api:auth_login>
         <api:apikey>?</api:apikey> <!-- API KEY -->
      </api:auth_login>
   </soapenv:Body>
</soapenv:Envelope>

Příklad odpovědi

{
    "status": "string",
    "token": "string",
    "expires_at": "string",
    "type": "string"
}

Příklady volání

fetch('https://api.plzensky-kraj.cz/api/auth/login/json', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + '<span class="curl-token text-success">YOUR_TOKEN</span>'
    },
    body: JSON.stringify({"apikey":"string"})
})
.then(res => res.json())
.then(data => console.log(data));

<?php
$url = 'https://api.plzensky-kraj.cz/api/auth/login/json';
// Data definovaná jako PHP pole pro lepší čitelnost
$data = array (
  'apikey' => 'string',
);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer <span class="curl-token text-success">YOUR_TOKEN</span>'
    ]
]);

$response = curl_exec($ch);
echo $response;

import requests

url = 'https://api.plzensky-kraj.cz/api/auth/login/json'
payload = {"apikey":"string"}
headers = {
    'Authorization': 'Bearer <span class="curl-token text-success">YOUR_TOKEN</span>'
}

# Knihovna requests se o JSON encoding postará sama přes parametr 'json'
response = requests.post(url, json=payload, headers=headers)
print(response.json())

using System.Net.Http.Json;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = 
    new AuthenticationHeaderValue("Bearer", "YOUR_TOKEN");

// Odeslání dat jako anonymního objektu
var payload = new { apikey = "..." };

var response = await client.PostAsJsonAsync(
    "https://api.plzensky-kraj.cz/api/auth/login/json", 
    payload
);

string content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);

<?php
$wsdl = "https://api.plzensky-kraj.cz/wsdl/?module=auth";

$options = [
    'trace'              => 1,
    'exceptions'         => true,
    'cache_wsdl'         => WSDL_CACHE_NONE,
    'connection_timeout' => 15,
    'stream_context'     => stream_context_create([
        'http' => [
            'header' => "Authorization: Bearer YOUR_TOKEN\r\n"
        ]
    ])
];

try {
    $client = new SoapClient($wsdl, $options);
    
    // Parametry pro volání
    $params = {
    "apikey": "string"
};

    // Standardní SOAP volání
    $response = $client->__soapCall('login', [$params]);
    print_r($response);

} catch (SoapFault $e) {
    echo "SOAP FAULT: " . $e->getMessage();
}

Vstupní parametry

{

"apikey"*:

{ // API KEY

"type": string,
"required": true,
"description": API KEY

}

Struktura odpovědi

{

"status": { // Request status"type": string,
"description": Request status
},
"token": { // JWT Token (RS256)"type": string,
"description": JWT Token (RS256)
},
"expires_at": { // Expiration date and time"type": datetime,
"description": Expiration date and time
},
"type": { // Token type (Bearer)"type": string,
"description": Token type (Bearer)
}

}

AUTENTIZAČNÍ PROTOKOL A HLAVIČKY (REST / SOAP)

Pro tuto metodu (REST i SOAP) postačuje základní autorizace pomocí statického klíče.

X-API-Key: váš_api_klíč

SOAP Poznámka: Endpoint /soap/?module=auth přebírá stejné HTTP hlavičky (X-Api-Key / Authorization) v transportní vrstvě.

METODYHTTP POSTSOAP

CONTENT-TYPEapplication/json / text/xml

Sandbox

{
    "apikey": "string"
}

GET https://api.plzensky-kraj.cz/api/auth/login_rs256/json/%7B%22apikey%22%3A%22string%22%7D

curl -X POST https://api.plzensky-kraj.cz/api/auth/login_rs256/json -H "Authorization: Bearer TOKEN" -d '{"apikey":"string"}'

using var klient = new HttpClient();
klient.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "TOKEN");

var telo = new StringContent(
    @"{""apikey"":""string""}",
    Encoding.UTF8, "application/json");

var odpoved = await klient.PostAsync("https://api.plzensky-kraj.cz/api/auth/login_rs256/json", telo);
odpoved.EnsureSuccessStatusCode();
var json = await odpoved.Content.ReadAsStringAsync();

$hlavicky = @{ Authorization = "Bearer TOKEN" }

$telo = '{"apikey":"string"}'

$odpoved = Invoke-RestMethod -Uri "https://api.plzensky-kraj.cz/api/auth/login_rs256/json" `
    -Method Post -Headers $hlavicky `
    -ContentType "application/json; charset=utf-8" -Body $telo

$odpoved | ConvertTo-Json -Depth 10

import requests

telo =  . $e($telo) . 

odpoved = requests.post(
    "https://api.plzensky-kraj.cz/api/auth/login_rs256/json",
    headers={
        "Authorization": "Bearer TOKEN",
        "Content-Type": "application/json; charset=utf-8",
    },
    data=telo.encode("utf-8"),
    timeout=30,
)
odpoved.raise_for_status()
data = odpoved.json()

HttpClient klient = HttpClient.newHttpClient();

HttpRequest pozadavek = HttpRequest.newBuilder()
    .uri(URI.create("https://api.plzensky-kraj.cz/api/auth/login_rs256/json"))
    .header("Authorization", "Bearer TOKEN")
    .header("Content-Type", "application/json; charset=utf-8")
    .POST(HttpRequest.BodyPublishers.ofString(
        """
        {"apikey":"string"}
        """, StandardCharsets.UTF_8))
    .build();

HttpResponse odpoved = klient.send(
    pozadavek, HttpResponse.BodyHandlers.ofString());

$ch = curl_init("https://api.plzensky-kraj.cz/api/auth/login_rs256/json");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => '{"apikey":"string"}',
    CURLOPT_HTTPHEADER     => [
        "Authorization: Bearer TOKEN",
        "Content-Type: application/json; charset=utf-8",
    ],
    CURLOPT_TIMEOUT        => 30,
]);

$odpoved = curl_exec($ch);
$data = json_decode($odpoved, true);

const odpoved = await fetch("https://api.plzensky-kraj.cz/api/auth/login_rs256/json", {
    method: "POST",
    headers: {
        "Authorization": "Bearer TOKEN",
        "Content-Type": "application/json",
    },
    body: JSON.stringify({"apikey":"string"}),
});

if (!odpoved.ok) throw new Error("HTTP " + odpoved.status);
const data = await odpoved.json();

Klíč se dosadí z levého panelu. Posílá se v hlavičce Authorization, ne v adrese – v logu serveru pak nezůstane.

Endpoint: https://api.plzensky-kraj.cz/soap/?module=auth

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://schema.kupk.cz/api/">
   <soapenv:Header/>
   <soapenv:Body>
      <api:auth_login_rs256>
         <api:apikey>?</api:apikey> <!-- API KEY -->
      </api:auth_login_rs256>
   </soapenv:Body>
</soapenv:Envelope>

Příklad odpovědi

{
    "status": "string",
    "token": "string",
    "expires_at": "string",
    "type": "string"
}

Příklady volání

fetch('https://api.plzensky-kraj.cz/api/auth/login_rs256/json', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer ' + '<span class="curl-token text-success">YOUR_TOKEN</span>'
    },
    body: JSON.stringify({"apikey":"string"})
})
.then(res => res.json())
.then(data => console.log(data));

<?php
$url = 'https://api.plzensky-kraj.cz/api/auth/login_rs256/json';
// Data definovaná jako PHP pole pro lepší čitelnost
$data = array (
  'apikey' => 'string',
);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer <span class="curl-token text-success">YOUR_TOKEN</span>'
    ]
]);

$response = curl_exec($ch);
echo $response;

import requests

url = 'https://api.plzensky-kraj.cz/api/auth/login_rs256/json'
payload = {"apikey":"string"}
headers = {
    'Authorization': 'Bearer <span class="curl-token text-success">YOUR_TOKEN</span>'
}

# Knihovna requests se o JSON encoding postará sama přes parametr 'json'
response = requests.post(url, json=payload, headers=headers)
print(response.json())

using System.Net.Http.Json;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = 
    new AuthenticationHeaderValue("Bearer", "YOUR_TOKEN");

// Odeslání dat jako anonymního objektu
var payload = new { apikey = "..." };

var response = await client.PostAsJsonAsync(
    "https://api.plzensky-kraj.cz/api/auth/login_rs256/json", 
    payload
);

string content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);

<?php
$wsdl = "https://api.plzensky-kraj.cz/wsdl/?module=auth";

$options = [
    'trace'              => 1,
    'exceptions'         => true,
    'cache_wsdl'         => WSDL_CACHE_NONE,
    'connection_timeout' => 15,
    'stream_context'     => stream_context_create([
        'http' => [
            'header' => "Authorization: Bearer YOUR_TOKEN\r\n"
        ]
    ])
];

try {
    $client = new SoapClient($wsdl, $options);
    
    // Parametry pro volání
    $params = {
    "apikey": "string"
};

    // Standardní SOAP volání
    $response = $client->__soapCall('login_rs256', [$params]);
    print_r($response);

} catch (SoapFault $e) {
    echo "SOAP FAULT: " . $e->getMessage();
}

Produkční brána systému

BASE ENDPOINT

https://api.plzensky-kraj.cz/

HTTP Status Legend

200 OK

400 Param Error

401 Auth Req

403 Forbidden

429 Rate Limit

500 Server Err

Standardní RFC 7231 odpovědi jádra systému.

Security Policies

LOW

X-API-Key

Veřejná data / číselníky.

MEDIUM

JWT HS256

Standardní uživatelský login.

HIGH

JWT RS256+

Kritické operace a podpisy.

OpenAPI Specifikace

https://api.plzensky-kraj.cz/{idmodulu}/openapi

OTEVŘÍT REDOC DOKUMENTACI

Dostupné komunikační strategie (prefixy)

/json/ Json

Standardní strojově zpracovatelný formát. Vrací validní JSON objekt v UTF-8.

/geojson/ GeoJson

Geografický formát (RFC 7946). Automaticky mapuje sloupce x/y nebo lat/lng na GeoJSON prvky bez přepočtu.

/url/ Url

Vrátí výslednou URL adresu jako prostý textový řetězec.

/urlopen/ UrlOpen

Provede okamžité přesměrování (HTTP 302) na cílovou URL adresu nalezenou v datech.

/html/ Html

Vykreslí data do přehledné interaktivní HTML tabulky pro zobrazení v prohlížeči.

/rawhtml/ RawHtml

Zobrazí surová data nebo strukturu pole přímo do prohlížeče bez formátování (vhodné pro ladění).

/csv/ Csv

Exportuje data do formátu CSV (hodnoty oddělené středníkem) jako soubor ke stažení.

/xlsx/ Xlsx

Export do Excelu (.xlsx). Vnořená data automaticky zplošťuje pomocí tečkové notace (např. auto.znacka).

/txt/ Txt

Vypíše data jako prostý text. V případě polí zobrazí jejich textovou strukturu.

/pdf/ Pdf

Export do PDF (vhodné pro tisk). Podporuje českou diakritiku a automatické tabulky.

/xml/ Xml

Transformuje data do standardního XML formátu s volitelným kořenovým elementem.

/soap/ Soap

Zabalí data do XML struktury kompatibilní s protokolem SOAP pro webové služby. Nutno volat z jiného endpointu /soap

KUPKAPI