Weboldalak

Jegyzetek
Szakértői szint
Az API kulcsot Bearer tokenként kell küldeni a kérés Authorization fejlécében. API kulcs beszerzése.
Lista

API végpont:

GET 
https://seoangyal.eu/api/v1/websites

Kérés példa: 

curl --location --request GET 'https://seoangyal.eu/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paraméter
Típus
Leírás
search
opcionális string
A keresési lekérdezés.
search_by
opcionális string
Keresés szerint. Lehetséges értékek: domain érték Domain számára. Alapértelmezett érték: domain.
favorite
opcionális boolean
Szűrés kedvencek szerint.
sort_by
opcionális string
Rendezés. Lehetséges értékek: id érték Létrehozás dátuma számára, domain érték Domain számára. Alapértelmezett érték: id.
sort
opcionális string
Rendezés. Lehetséges értékek: desc érték Csökkenő számára, asc érték Növekvő számára. Alapértelmezett érték: desc.
per_page
opcionális integer
Találatok oldalanként. Lehetséges értékek: 10, 25, 50, 100. Alapértelmezett érték: 10.
Megjelenítés

API végpont:

GET 
https://seoangyal.eu/api/v1/websites/{id}

Kérés példa: 

curl --location --request GET 'https://seoangyal.eu/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Tárolás

API végpont:

POST 
https://seoangyal.eu/api/v1/websites

Kérés példa: 

curl --location --request POST 'https://seoangyal.eu/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Paraméter
Típus
Leírás
domain
kötelező string
A domain név.
privacy
opcionális integer
Statisztikai oldal adatvédelme. Lehetséges értékek: 0 érték Nyilvános számára, 1 érték Privát számára, 2 érték Jelszó számára. Alapértelmezett érték: 0.
password
opcionális string
A statisztikai oldal jelszava. Csak akkor működik, ha a(z) privacy értéke 2.
email
opcionális integer
Időszakos e-mail jelentések. Lehetséges értékek: 0 érték Letiltva számára, 1 érték Engedélyezve számára. Alapértelmezett érték: 0.
exclude_bots
opcionális integer
A gyakori robotokat zárja ki a nyomkövetésből. Lehetséges értékek: 0 érték Letiltva számára, 1 érték Engedélyezve számára. Alapértelmezett érték: 1.
exclude_params
opcionális string
Exclude URL query parameters from being tracked. Soronként egy..
exclude_ips
opcionális string
Az IP-címeket zárja ki a nyomkövetésből. Soronként egy..
Frissítés

API végpont:

PUT PATCH 
https://seoangyal.eu/api/v1/websites/{id}

Kérés példa: 

curl --location --request PUT 'https://seoangyal.eu/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paraméter
Típus
Leírás
privacy
opcionális integer
Statisztikai oldal adatvédelme. Lehetséges értékek: 0 érték Nyilvános számára, 1 érték Privát számára, 2 érték Jelszó számára.
password
opcionális string
A statisztikai oldal jelszava. Csak akkor működik, ha a(z) privacy értéke 2.
email
opcionális integer
Időszakos e-mail jelentések. Lehetséges értékek: 0 érték Letiltva számára, 1 érték Engedélyezve számára.
exclude_bots
opcionális integer
A gyakori robotokat zárja ki a nyomkövetésből. Lehetséges értékek: 0 érték Letiltva számára, 1 érték Engedélyezve számára.
exclude_params
opcionális string
Exclude URL query parameters from being tracked. Soronként egy..
exclude_ips
opcionális string
Az IP-címeket zárja ki a nyomkövetésből. Soronként egy..
favorite
opcionális boolean
Hogy a weboldal kedvenc-e vagy sem.
Törlés

API végpont:

DELETE 
https://seoangyal.eu/api/v1/websites/{id}

Kérés példa: 

curl --location --request DELETE 'https://seoangyal.eu/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'