Repo Visitor Counter API

İçindekiler

• API Hakkında
• Dokümantasyon
• İstek Örnekleri
• Lisans
• İletişim

API Hakkında

Bu repo, GitHub repo ziyaretlerini takip eden sayaç API'nin dokümantasyonunu içerir.

HTTP GET istekleriyle repo, bg_color, txt_color, show_date, show_repo_name, show_brand parametrelerini alır ve belirli bir repoya yapılan ziyaretlerin sayısını izler ve bu bilgileri dinamik olarak oluşturulmuş bir PNG resim olarak sunar.

Yanıltıcı sonuçları önleyebilmek adına aynı repo için aynı IP adresinden gelen istekler yalnızca 10 dakikada bir kaydedilir.

Dokümantasyon

Base URL: https://toktasoft.com/api/repo-visitor-counter

API 6 farklı parametre almaktadır.

Parametre	Zorunlu Mu?	Değerler	Varsayılan Değer	Açıklama
repo	evet	Repo'nun API veritabanındaki ID değeri
bg_color	hayır	RGB renk kodları	34,39,46	Resmin arkaplan rengi için RGB renk kodunun yazıldığı parametre
txt_color	hayır	RGB renk kodları	197,239,222	Yazı rengi için RGB renk kodunun yazıldığı parametre
show_date	hayır	1 0	0	1 veya 0'dan başka bir değer girilirse 0 değeri yazılmış gibi işlem görür.
show_repo_name	hayır	1 0	0	1 veya 0'dan başka bir değer girilirse 0 değeri yazılmış gibi işlem görür.
show_brand	hayır	1 0	1	1 veya 0'dan başka bir değer girilirse 1 değeri yazılmış gibi işlem görür. Ayrıcalıklı olmayan kullanıcılar parametreye 0 değerini yazsalar bile API sağlayıcı adı resim üzerinde gösterilmeye devam edilir.

API'yi kullanmak isteyen kullanıcıların repolarını API veritabanına kaydettirmek için iletişime geçmesi gerekmektedir.

• Repo ve Kullanıcı Yönetimi: Kullanıcılar API veritabanına kayıtlı repolarıyla eşleştirilir. Yalnızca ayrıcalıklı kullanıcılar show_brand parametresini kontrol edebilir.
• Ziyaret Sayısı Takibi: Her başarılı istek sonrası ilgili repo için aylık ve toplam ziyaretçi sayıları güncellenir.

İstek Örnekleri

İstek örnekleri curl komut satırı aracı kullanılarak gösterilmiştir.

✅ Sadece zorunlu olan parametre isteği

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz"

✅ Repo adı bilgisinin yazdırıldığı istek

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz&show_repo_name=1"

✅ Tarih bilgisinin yazdırıldığı istek

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz&show_date=1"

✅ Tarih ve repo adı bilgisinin yazdırıldığı istek

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz&show_date=1&show_repo_name=1"

✅ Tarih ve repo adının yazdırıldığı, API sağlayıcı bilgisinin yazdırılmadığı istek

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz&show_date=1&show_repo_name=1&show_brand=0"

✅ Tarih, Repo adı, API sağlayıcı bilgisinin yazdırıldığı ve renklerin değiştirildiği istek

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz&show_date=1&show_repo_name=1&show_brand=1&bg_color=0,0,0&txt_color=0,255,0"

❌ Yanlış İstek

repo parametresine API veritabanında bulunmayan bir ID değeri yazılırsa hata mesajı yazan resim döndürülür.

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=bulunmayaniddegeri"

❌ Yanlış İstek

bg_color ve txt_color parametrelerine RGB formatında olmayan değerler yazılırsa hata mesajı yazan resim döndürülür.

curl -X GET "https://toktasoft.com/api/repo-visitor-counter?repo=h2fktgj3v8e69nz&bg_color=-11,0,0&txt_color=300,300,300"

Lisans

Copyright 2024-2025 Mustafa TOKTAŞ

Licensed under the GNU General Public License v3.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.gnu.org/licenses/gpl-3.0.html

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

İletişim