Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mustafatoktas/w.be_burcapi
Burç Yorumlarını JSON Formatında Sunan API
https://github.com/mustafatoktas/w.be_burcapi
api horoscope-api
Last synced: 11 days ago
JSON representation
Burç Yorumlarını JSON Formatında Sunan API
- Host: GitHub
- URL: https://github.com/mustafatoktas/w.be_burcapi
- Owner: mustafatoktas
- License: gpl-3.0
- Created: 2024-07-01T03:50:52.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T15:49:18.000Z (3 months ago)
- Last Synced: 2024-08-25T17:00:57.339Z (3 months ago)
- Topics: api, horoscope-api
- Homepage:
- Size: 416 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Burç 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 burç yorumlarını ve bilgilerini sunan
API'nin dokümantasyonunu içerir.
HTTP GET istekleriyle `burc`, `tip` ve `api_key` parametrelerini alır ve bütün burçların
günlük, haftalık, aylık, yıllık yorumlarını JSON formatında sağlar.
JSON dosyasında her burç için burcu temsil eden 256 x 256 çözünürlüğünde png uzantılı resim barındıran url adresi de bulunmaktadır.
Ayrıca tip parametresine "genel" değeri yazılarak burçların detaylı karakter özellikleri öğrenilebilir.
## Dokümantasyon
Base URL: `https://toktasoft.com/api/burclar.php`
API 3 farklı parametre almaktadır.
| Parametre | Zorunlu Mu? | Değerler | Varsayılan Değer | Açıklama |
| ------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | -------------------------------- |
|
`burc`
| evet
| `oglak`
`boga`
`ikizler`
`yengec`
`aslan`
`basak`
`terazi`
`akrep`
`yay`
`koc`
`kova`
`balik` | | Bilgileri istenen burcun değeri. |
| `tip`
| hayır
| `gunluk`
`haftalik`
`aylik`
`yillik`
`genel` | gunluk
| Yorumu istenilen burcun tip değeri. Burcun genel özellikleri için genel değeri yazılmalıdır. |
| `api_key`
| evet
| API anahtarı | | Api key'ler aylık maksimum 100 istek ile sınırlandırılmıştır. Api key sahibi olabilmek veya ayrıcalıklı kullanıcı statüsüne geçip sınırsız istek hakkına sahip olabilmek için iletişime geçmeniz gerekmektedir. |
## İstek Örnekleri
İstek örnekleri `curl` komut satırı aracı kullanılarak gösterilmiştir.
✅**Oğlak burcunun günlük yorumu**
```sh
curl -X GET "https://toktasoft.com/api/burclar.php?burc=oglak&api_key=myapikey"
```
```json
{
"success": true,
"result": {
"burc": "oglak",
"tip": "gunluk",
"tarih": "2024-07-02",
"hafta_numarasi": "27",
"ay_numarasi": "7",
"yil": "2024",
"yorum": "Merhaba! Bugün Oğlak burcu için ...",
"resim_url": "https://toktasoft.com/..."
},
"monthly_request_count": 34
}
```
✅**Oğlak burcunun haftalık yorumu**
```sh
curl -X GET "https://toktasoft.com/api/burclar.php?burc=oglak&tip=haftalik&api_key=myapikey"
```
```json
{
"success": true,
"result": {
"burc": "oglak",
"tip": "haftalik",
"tarih": "2024-08-05",
"hafta_numarasi": "32",
"ay_numarasi": "8",
"yil": "2024",
"yorum": "Bu hafta, iş ve kariyer alanında ...",
"resim_url": "https://toktasoft.com/..."
},
"monthly_request_count": 67
}
```
✅**Oğlak burcunun genel özellikleri**
```sh
curl -X GET "https://toktasoft.com/api/burclar.php?burc=oglak&tip=genel&api_key=myapikey"
```
```json
{
"success": true,
"result": {
"yonetici_gezegeni_yildizi": "Satürn",
"gruplar": [
"Toprak",
"Öncü",
"Negatif",
"Dişi"
],
"temsil_ettigi_ev": "10. Ev",
"vucutta_temsil_ettigi_yer": [
"Diz",
"Diş",
"Kemikler"
],
"genel": "Toprak grubunun üyelerinden olan Oğlak burcu ...",
"is_hayati": "Aslında iş hayatının burçlardaki karşılığı Oğlak burcudur ...",
"saglik": "Dayanıklı Oğlak burçları ...",
"unluler": [
"Muhammad Ali",
"Barış Manço",
"Burak Özçivit",
],
"iliskiler": "Duygularını göstermekte zorlanan ...",
"kadin": "Hayatının her alanında olduğu gibi ...",
"erkek": "Sevgisini belli edemeyen Oğlak erkeği ...",
"resim_url": "https://toktasoft.com/..."
},
"monthly_request_count": 81
}
```
❌**Yanlış istek**
`burc` parametresine tablodaki değerler dışında bir değer girilirse hata döndürülür.
```sh
curl -X GET "https://toktasoft.com/api/burclar.php?burc=zurafa&tip=aylik&api_key=myapikey"
```
```json
{
"success": false,
"error": "Geçersiz burç parametresi.",
"monthly_request_count": 105
}
```
❌**Yanlış istek**
`tip` parametresine tablodaki değerler dışında bir değer girilirse hata döndürülür.
```sh
curl -X GET "https://toktasoft.com/api/burclar.php?burc=oglak&tip=omurluk&api_key=myapikey"
```
```json
{
"success": false,
"error": "Geçersiz tip parametresi.",
"monthly_request_count": 204
}
```
## 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
