BLOKET, Dokümantasyon

BLOKET hakkında teknik detaylar, kullanım ve sorun giderme.

API Fonksiyonları


Authentication

API fonksiyonlarına erişmek için istemci'nin (client) HTTP Header alanlarından Authorization anahtarını göndermesi gerekmektedir.

API Anahtarı

API anahtarına bloket-ui servisinin app.conf dosyası içinden ulaşabilirsiniz

/usr/local/bin/ui/conf/app.conf

İlgili alan APIKey ismi ile konfigürasyon dosyasında bulunmaktadır.

APIKey = OOdkkd!^9900**

Eğer istek sırasında Authorization header bilgisini göndermezseniz aşağıdaki şekilde bir hata alırsınız.

{
    "Code": "401",
    "Success": false,
    "Message": "Unauthorized. Lütfen API anahtarınızı kontrol ediniz.",
    "Data": null
}

URL Engelleme Fonksiyonları


POST /api/v1/add

BLOKET'in yeni bir URL engellemesi için Add fonksiyonunu çağırmalısınız. Bu fonksiyon iki parametre alabilir.

url (string) Eklenecek URL
desc (string) URL engellendiği zaman ziyaretçinin karşısına çıkarılacak açıklama/neden içeren metin.

İstek

curl -X POST -X "Authorization APIKEYFROMCONFIG" \
    --data "url=http://zararli.url.com&desc=bu url zararlı yazılım dağıtmaktadır" \
     http://192.168.5.5:900/api/v1/add 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "URL başarılı bir şekilde eklendi.",
    "Data": 26
}

GET /api/v1/exists

Daha önce eklenmiş bir URL arıyorsanız kullanabileceğiniz fonksiyondur. GET isteği ile çalışmasına dikkat ediniz.

url (string) Sorgulanacak URL

İstek

curl -X POST -X "Authorization APIKEYFROMCONFIG" \
    --data "url=http://zararli.url.com&desc=bu url zararlı yazılım dağıtmaktadır" \
     http://192.168.5.5:900/api/v1/add 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "URL başarılı bir şekilde eklendi.",
    "Data": 26
}

DELETE /api/v1/delete

Daha önce eklenmiş bir URL adresini silmek için kullanabileceğiniz fonksiyondur. DELETE http metodu ile çalışmasına dikkat ediniz. POST göndediğinizde 404 hatası alırsınız.

url (string) Silinecek URL

İstek

curl -X POST -X "Authorization APIKEYFROMCONFIG" \
    --data "url=http://zararli.url.com&desc=bu url zararlı yazılım dağıtmaktadır" \
     http://192.168.5.5:900/api/v1/add 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "URL başarılı bir şekilde eklendi.",
    "Data": 26
}

Güvenli Internet Fonksiyonları

İlgili yasaya göre Erişim Sağlayıcı lisansına sahip olan firmalar abonelerine güvenli internet adı altında sunulan ve belirli profillerde URL filtrelemesi gerçekleştiren internet erişimini abonelerine sunmakla yükümlüdür. Daha fazla bilgi için http://www.guvenlinet.org


POST /api/v1/profile/add

Bir IP adresinden gelen istekleri güvenli internet kapsamına almak için kullanılan fonksiyondur.

sourceip Abonenin sabit IP adresi (Aile filtresi ayrımı abonenin IP adresine göre yapılır)
IPv4 formatı olması zorunludur.
profile Abone'nin hangi profilde hareket edeceğini belirtir.
Alabileceği değerler:
bu (Çocuk Profili)
k (Aile Profili)
kc (Aile Profili + Sohbet işaretli sitelere erişim yok.)
kou (Aile Profili + Oyun işaretli sitelere erişim yok.)
ks (Aile Profili + Sosyal Medya işaretli sitelere erişim yok.)
kcou (Aile Profili + Oyun + Sohbet işaretli sitelere erişim yok.)
kous (Aile Profili + Oyun + Sosyal Medya işaretli sitelere erişim yok.)
kcs (Aile Profili + Sohbet + Sosyal Medya işaretli sitelere erişim yok.)
kcous (Aile Profili + Sohbet + Oyun + Sosyal Medya işaretli sitelere erişim yok.)

İstek

curl -X POST -X "Authorization APIKEYFROMCONFIG" \
    --data "sourceip=192.168.5.5&profile=k" \
     http://192.168.5.5:900/api/v1/profile/add 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "Profile başarılı bir şekilde eklendi. (1 dakika sonra ağ üzerinde aktif olacaktır)",
    "Data": null
}

DELETE /api/v1/profile/delete

Daha önce eklenen profil bilgisini sistemden siler. HTTP method'unun DELETE olmasına dikkat edilmelidir.

sourceip Abonenin sabit IP adresi (Aile filtresi ayrımı abonenin IP adresine göre yapılır)
IPv4 formatı olması zorunludur.

İstek

curl -X DELETE -X "Authorization APIKEYFROMCONFIG" \
    --data "sourceip=192.168.5.5" \
     http://192.168.5.5:900/api/v1/profile/delete 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "Profile başarılı bir şekilde silindi. (1 dakika sonra ağ üzerinde aktif olacaktır)",
    "Data": null
}

POST /api/v1/profile/update

Daha önce eklenen profil bilgisini günceller.

sourceip Abonenin sabit IP adresi (Aile filtresi ayrımı abonenin IP adresine göre yapılır)
IPv4 formatı olması zorunludur.

İstek

curl -X POST -X "Authorization APIKEYFROMCONFIG" \
    --data "sourceip=192.168.5.5&profile=kc" \
     http://192.168.5.5:900/api/v1/profile/update 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "Profile başarılı bir şekilde güncellendi. (1 dakika sonra ağ üzerinde aktif olacaktır)",
    "Data": null
}

GET /api/v1/profile/exists

IP üzerinden profil bilgisini sorgulamanızı sağlar.

sourceip Abonenin sabit IP adresi (Aile filtresi ayrımı abonenin IP adresine göre yapılır)
IPv4 formatı olması zorunludur.

İstek

curl -X GET -X "Authorization APIKEYFROMCONFIG" \
    http://192.168.5.5:900/api/v1/profile/exists?sourceip=192.168.5.5 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "",
    "Data": {
        "IPaddr": "192.168.5.5",
        "Name": "kc"
    }
}

GET /api/v1/profile/list

Tüm IP adresi ve profil bilgilerini listeler.

Bu fonksiyonda parametre bulunmuyor.

İstek

curl -X GET -X "Authorization APIKEYFROMCONFIG" \
    http://192.168.5.5:900/api/v1/profile/list 

Cevap

{
    "Code": "200",
    "Success": true,
    "Message": "",
    "Data": [
        {
            "IPaddr": "192.168.2.5",
            "Name": "bu"
        },
        {
            "IPaddr": "192.168.2.130",
            "Name": "kc"
        },
        {
            "IPaddr": "192.168.2.133",
            "Name": "kou"
        },
        {
            "IPaddr": "192.168.2.134",
            "Name": "kcos"
        },
        {
            "IPaddr": "192.168.5.5",
            "Name": "k"
        },
        {
            "IPaddr": "192.168.5.3",
            "Name": "k"
        }
    ]
}

API hakkında yardım için info@bloket.pro email hesabı ile etişime geçebilirsiniz.

bloket.pro

İstanbul Üniversitesi Avcılar Yerleşkesi Teknokent Binası Z19, İstanbul. Tel: +90 850 885 0004, Eposta: info@bloket.pro