Domény - Pro vývojáře

Poznámky

Level EXPERT

Klíč API by měl být odeslán jako token nositele v hlavičce Authorization požadavku. Získejte klíč API.

List

API endpoint:

GET

https://zkracovac.cz/api/v1/domains

Příklad requestu:

curl --location --request GET 'https://zkracovac.cz/api/v1/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parametr

Typ

Popis

search

volitelné string

Vyhledávací dotaz.

search_by

volitelné string

Hledat podle. Možné hodnoty jsou: name pro Jméno. Výchozí hodnota: name.

sort_by

volitelné string

Sort by. Možné hodnoty jsou: id pro Date created, name pro Jméno. Výchozí hodnota: id.

sort

volitelné string

Seřadit. Možné hodnoty jsou: desc pro Sestupně, asc pro Vzestupně. Výchozí hodnota: desc.

per_page

volitelné int

Výsledky na stránku. Možné hodnoty jsou: 10, 25, 50, 100. Výchozí hodnota: 25.

Show

API endpoint:

GET

https://zkracovac.cz/api/v1/domains/{id}

Příklad requestu:

curl --location --request GET 'https://zkracovac.cz/api/v1/domains/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Store

API endpoint:

POST

https://zkracovac.cz/api/v1/domains

Příklad requestu:

curl --location --request POST 'https://zkracovac.cz/api/v1/domains' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'

Parametr

Typ

Popis

name

požadováno string

Název space.

index_page

volitelné string

Indexová stránka, na kterou se má přesměrovat.

not_found_page

volitelné string

Stránka 404, na kterou se má přesměrovat.

Update

API endpoint:

PUT PATCH

https://zkracovac.cz/api/v1/domains/{id}

Příklad requestu:

curl --location --request PUT 'https://zkracovac.cz/api/v1/domains/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parametr

Typ

Popis

index_page

volitelné string

Indexová stránka, na kterou se má přesměrovat.

not_found_page

volitelné string

Stránka 404, na kterou se má přesměrovat.

Smazat

API endpoint:

DELETE

https://zkracovac.cz/api/v1/domains/{id}

Příklad requestu:

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