Odkazy

Poznámky
Pro experty
Klíč API by měl být odeslán jako token Bearer v hlavičce Authorization požadavku. Získejte klíč API.
Seznam

Koncový bod API:

GET 
https://sqzr.cz/api/v1/links

Příklad žádosti: 

curl --location --request GET 'https://sqzr.cz/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parametr
Typ
Popis
search
volitelné string
Vyhledávací dotaz.
search_by
volitelné string
Hledat dle. Možné hodnoty jsou: title pro Název, alias pro Alias, url pro URL. Výchozí hodnota: title.
status
volitelné integer
Filtrovat podle stavu. Možné hodnoty jsou: 0 pro Vše, 1 pro Aktivní, 2 pro Vypršela platnost, 3 pro Deaktivovat?. Výchozí hodnota: 0.
space_id
volitelné integer
Filtrovat dle ID prostoru.
domain_id
volitelné integer
Filtrovat dle ID domény.
pixel_id
volitelné integer
Filtrovovat podle ID pixelu.
sort_by
volitelné string
Řadit dle. Možné hodnoty jsou: id pro Vytvořeno, clicks pro Kliknutí, title pro Název, alias pro Alias, url pro URL. Výchozí hodnota: id.
sort
volitelné string
Třídit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.
per_page
volitelné integer
Výsledků na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 50.
Zobrazit

Koncový bod API:

GET 
https://sqzr.cz/api/v1/links/{id}

Příklad žádosti: 

curl --location --request GET 'https://sqzr.cz/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Ukládat

Koncový bod API:

POST 
https://sqzr.cz/api/v1/links

Příklad žádosti: 

curl --location --request POST 'https://sqzr.cz/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parametr
Typ
Popis
url
vyžadováno string
Odkaz, který má být zkrácen.
domain_id
vyžadováno integer
ID domény, pod kterým má být odkaz uložen.
alias
volitelné string
Alias odkazu.
password
volitelné string
Heslo odkazu.
space_id
volitelné integer
ID prostoru, pod kterým má být odkaz uložen.
pixel_ids
volitelné array
The pixel IDs to be integrated in the link.
disabled
volitelné integer
Zda je odkaz zakázán, nebo ne. Možné hodnoty jsou: 0 pro Aktivní, 1 pro Deaktivovat?. Výchozí hodnota: 0.
privacy
volitelné integer
Ať už jsou statistiky odkazů veřejné, nebo ne. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo. Výchozí hodnota: 0.
privacy_password
volitelné string
Heslo pro stránku statistik. Funguje pouze při nastavení privacy na 2.
expiration_url
volitelné string
Odkaz, na který bude uživatel přesměrován po vypršení platnosti odkazu.
expiration_date
volitelné string
Datum vypršení platnosti odkazu ve formátu YYYY-MM-DD.
expiration_time
volitelné string
Čas vypršení platnosti odkazu ve formátu HH:MM.
expiration_clicks
volitelné integer
Počet kliknutí, po kterých má odkaz vypršet.
target_type
volitelné integer
Typ zaměření. Možné hodnoty jsou: 0 pro Žádné, 1 pro Zeměpisný, 2 pro Platforma, 4 pro Střídání odkazů.
country[index][key]
volitelné string
Kód cílové země. Kód musí být v normě ISO 3166-1 alpha-2.
country[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
platform[index][key]
volitelné string
Název cílové platformy. Možné hodnoty jsou: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
language[index][key]
volitelné string
Kód cíleného jazyka. Kód musí být v normě ISO 639-1 alpha-2.
language[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
rotation[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
Aktualizovat

Koncový bod API:

PUT PATCH 
https://sqzr.cz/api/v1/links/{id}

Příklad žádosti: 

curl --location --request PUT 'https://sqzr.cz/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parametr
Typ
Popis
url
volitelné string
Odkaz, který má být zkrácen.
alias
volitelné string
Alias odkazu.
password
volitelné string
Heslo odkazu.
space_id
volitelné integer
ID prostoru, pod kterým má být odkaz uložen.
pixel_ids
volitelné array
The pixel IDs to be integrated in the link.
disabled
volitelné integer
Zda je odkaz zakázán, nebo ne. Možné hodnoty jsou: 0 pro Aktivní, 1 pro Deaktivovat?.
privacy
volitelné integer
Ať už jsou statistiky odkazů veřejné, nebo ne. Možné hodnoty jsou: 0 pro Veřejné, 1 pro Soukromé, 2 pro Heslo.
privacy_password
volitelné string
Heslo pro stránku statistik. Funguje pouze při nastavení privacy na 2.
expiration_url
volitelné string
Odkaz, na který bude uživatel přesměrován po vypršení platnosti odkazu.
expiration_date
volitelné string
Datum vypršení platnosti odkazu ve formátu YYYY-MM-DD.
expiration_time
volitelné string
Čas vypršení platnosti odkazu ve formátu HH:MM.
expiration_clicks
volitelné integer
Počet kliknutí, po kterých má odkaz vypršet.
target_type
volitelné integer
Typ zaměření. Možné hodnoty jsou: 0 pro Žádné, 1 pro Zeměpisný, 2 pro Platforma, 4 pro Střídání odkazů.
country[index][key]
volitelné string
Kód cílové země. Kód musí být v normě ISO 3166-1 alpha-2.
country[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
platform[index][key]
volitelné string
Název cílové platformy. Možné hodnoty jsou: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
language[index][key]
volitelné string
Kód cíleného jazyka. Kód musí být v normě ISO 639-1 alpha-2.
language[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
rotation[index][value]
volitelné string
Odkaz, na který bude uživatel přesměrován.
Odstranit

Koncový bod API:

DELETE 
https://sqzr.cz/api/v1/links/{id}

Příklad žádosti: 

curl --location --request DELETE 'https://sqzr.cz/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'