Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mustafatoktas/w.be_repovisitorcounterapi
Belirli Bir Reponun Ziyaret Sayısını PNG Formatında Sunan API
https://github.com/mustafatoktas/w.be_repovisitorcounterapi
api repo-visitor-counter-api
Last synced: 11 days ago
JSON representation
Belirli Bir Reponun Ziyaret Sayısını PNG Formatında Sunan API
- Host: GitHub
- URL: https://github.com/mustafatoktas/w.be_repovisitorcounterapi
- Owner: mustafatoktas
- License: gpl-3.0
- Created: 2024-07-31T12:24:23.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T15:51:02.000Z (3 months ago)
- Last Synced: 2024-08-25T17:01:53.351Z (3 months ago)
- Topics: api, repo-visitor-counter-api
- Homepage:
- Size: 122 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Repo Visitor Counter API
## **İçindekiler**
- [API Hakkında](#api-hakkında)
- [Dokümantasyon](#dokümantasyon)
- [İstek Örnekleri](#i̇stek-örnekleri)
- [Lisans](#lisans)
- [İletişim](#i̇letişim)
## API Hakkında
Bu repo, PHP diliyle geliştirilmiş olan 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 görüntü 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/github2/repo-visitor-counter.php`
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,36
| Resmin arkaplan rengi için RGB renk kodunun yazıldığı parametre |
| `txt_color`
| hayır
| `RGB renk kodları` | 197,239,222
| Resimdeki yazılar 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. Ayrıcalıklı kullanıcılar `show_brand` parametresini kontrol edebilir.
- **IP Adresi Takibi:** API, aynı IP adresinden aynı repo için yapılan istekleri 10 dakikada bir kaydeder, böylece yanıltıcı ziyaret sayıları önlenir.
- **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**
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=h2fktgj3v8e69nz"
```
✅**Repo adı bilgisinin yazdırıldığı istek**
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=h2fktgj3v8e69nz&show_repo_name=1"
```
✅**Tarih bilgisinin yazdırıldığı istek**
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=h2fktgj3v8e69nz&show_date=1"
```
✅**Tarih ve Repo adı bilgisinin yazdırıldığı istek**
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=h2fktgj3v8e69nz&show_date=1&show_repo_name=1"
```
✅**Tarih, Repo adı ve API sağlayıcı bilgisinin yazdırıldığı istek**
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=h2fktgj3v8e69nz&show_date=1&show_repo_name=1&show_brand=1"
```
✅**Tarih, Repo adı, API sağlayıcı bilgisinin yazdırıldığı ve renklerin değiştirildiği istek**
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?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 resim oluşturulmaz.
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=11111111111"
```
❌**Yanlış İstek**
Geçersiz bir RGB renk kodu yazılırsa resim oluşturulmaz.
```sh
curl -X GET "https://toktasoft.com/api/github2/repo-visitor-counter.php?repo=h2fktgj3v8e69nz&bg_color=0,0,0&txt_color=300,300,300"
```
## Lisans
```
Copyright 2024 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
