Raporlar - Geliştiriciler

Notes

Uzman seviyesi

API anahtarı, isteğin Authorization başlığında Bearer token olarak gönderilmelidir. API anahtarınızı alın.

List

API uç noktası:

GET

https://checkmysite.ir/api/v1/reports

İstek örneği:

curl --location --request GET 'https://checkmysite.ir/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parametre

Tür

Açıklama

search

i̇steğe bağlı string

Arama sorgusu.

search_by

i̇steğe bağlı string

Şuna göre ara. Olası değerler: URL için url. Varsayılan: url.

website

i̇steğe bağlı string

Web sitesi adı

result

i̇steğe bağlı string

Rapor sonucu. Olası değerler: İyi için good, Decent için decent, Bad için bad.

sort_by

i̇steğe bağlı string

Sırala. Olası değerler: Oluşturulma tarihi için id, Oluşturulma tarihi için generated_at, URL için url, Puan için score. Varsayılan: id.

sort

i̇steğe bağlı string

Sort. Olası değerler: Azalan için desc, Artan için asc. Varsayılan: desc.

per_page

i̇steğe bağlı integer

Sayfa başına sonuç. Olası değerler: 10, 25, 50, 100. Varsayılan: 10.

Show

API uç noktası:

GET

https://checkmysite.ir/api/v1/reports/{id}

İstek örneği:

curl --location --request GET 'https://checkmysite.ir/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Store

API uç noktası:

POST

https://checkmysite.ir/api/v1/reports

İstek örneği:

curl --location --request POST 'https://checkmysite.ir/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Parametre

Tür

Açıklama

url

zorunlu string

Web sayfasının URL'si.

privacy

i̇steğe bağlı integer

Rapor sayfası gizliliği. Olası değerler: Herkese Açık için 0, Özel için 1, Şifre için 2. Varsayılan: 0.

password

i̇steğe bağlı string

Rapor sayfasının şifresi. Yalnızca privacy alanı 2 olarak ayarlandığında çalışır.

Update

API uç noktası:

PUT PATCH

https://checkmysite.ir/api/v1/reports/{id}

İstek örneği:

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

Parametre

Tür

Açıklama

privacy

i̇steğe bağlı integer

Rapor sayfası gizliliği. Olası değerler: Herkese Açık için 0, Özel için 1, Şifre için 2.

password

i̇steğe bağlı string

Rapor sayfasının şifresi. Yalnızca privacy alanı 2 olarak ayarlandığında çalışır.

update

i̇steğe bağlı integer

Update. Olası değerler: Hayır için 0, Evet için 1. Varsayılan: 0.

Sil

API uç noktası:

DELETE

https://checkmysite.ir/api/v1/reports/{id}

İstek örneği:

curl --location --request DELETE 'https://checkmysite.ir/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'