Vefsíður

Athugasemdir
Forritarastig
The API key should be sent as a Bearer token in the Authorization header of the request. Fáðu API lykilinn þinn.
Listi

API endapunktur:

GET 
https://teljari.is/api/v1/websites

Dæmi um request: 

curl --location --request GET 'https://teljari.is/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tegund
Lýsing
search
valfrjálst string
Leitarfyrirspurnin.
sort
valfrjálst string
Flokka. Möguleg gildi eru: desc fyrir Z-A, asc fyrir A-Z.
per_page
valfrjálst int
Niðurstöður á síðu. Möguleg gildi eru: 10 til 100. Sjálfgefið er: 20.
Sýna

API endapunktur:

GET 
https://teljari.is/api/v1/websites/{id}

Dæmi um request: 

curl --location --request GET 'https://teljari.is/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Verslun

API endapunktur:

POST 
https://teljari.is/api/v1/websites

Dæmi um request: 

curl --location --request POST 'https://teljari.is/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Tegund
Lýsing
url
skilyrði string
Vefslóð vefsíðunnar.
privacy
valfrjálst integer
Persónuvernd tölfræðisíðu. Möguleg gildi eru: 0 fyrir Opið, 1 fyrir Lokað, 2 fyrir Lykilorð. Sjálfgefið er: 1.
password
valfrjálst string
Lykilorðið fyrir tölfræðisíðuna. Virkar aðeins með privacy stillt á 2.
email
valfrjálst integer
Reglubundnar tölvupóstskýrslur. Möguleg gildi eru: 0 fyrir Óvirkt, 1 fyrir Virkt. Sjálfgefið er: 0.
exclude_bots
valfrjálst integer
Útiloka að fylgst sé með algengum vélmennum. Möguleg gildi eru: 0 fyrir Óvirkt, 1 fyrir Virkt. Sjálfgefið er: 1.
exclude_params
valfrjálst string
Exclude URL query parameters from being tracked. Einn á línu.
exclude_ips
valfrjálst string
Útiloka IP-tölur Einn á línu.
Uppfærsla

API endapunktur:

PUT PATCH 
https://teljari.is/api/v1/websites/{id}

Dæmi um request: 

curl --location --request PUT 'https://teljari.is/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Tegund
Lýsing
privacy
valfrjálst integer
Persónuvernd tölfræðisíðu. Möguleg gildi eru: 0 fyrir Opið, 1 fyrir Lokað, 2 fyrir Lykilorð.
password
valfrjálst string
Lykilorðið fyrir tölfræðisíðuna. Virkar aðeins með privacy stillt á 2.
email
valfrjálst integer
Reglubundnar tölvupóstskýrslur. Möguleg gildi eru: 0 fyrir Óvirkt, 1 fyrir Virkt.
exclude_bots
valfrjálst integer
Útiloka að fylgst sé með algengum vélmennum. Möguleg gildi eru: 0 fyrir Óvirkt, 1 fyrir Virkt.
exclude_params
valfrjálst string
Exclude URL query parameters from being tracked. Einn á línu.
exclude_ips
valfrjálst string
Útiloka IP-tölur Einn á línu.
Eyða

API endapunktur:

DELETE 
https://teljari.is/websites/{id}/destroy

Dæmi um request: 

curl --location --request DELETE 'https://teljari.is/websites/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'