Hızlı Başlangıç
Aşağıdaki adresi tarayıcınıza yapıştırmanız yeterli:
https://www.ornekfirma.com/api/v1/kullanicilar/5
Örnek yanıt:
{
"id": 5,
"ad": "Zeynep",
"soyad": "Öztürk",
"kullaniciAdi": "zeynepozturk42",
"eposta": "zeynepozturk42@ornekfirma.com",
"telefon": "+90 532 456 78 90",
"firmaId": 12,
"unvan": "Pazarlama Müdürü",
"adres": {
"il": "İzmir",
"ilce": "Karşıyaka",
"mahalle": "Cumhuriyet Mahallesi",
...
}
}
Kaynaklar
API'de 9 kaynak ve toplam 400'den fazla ilişkili kayıt bulunur. Tüm veriler kurgusaldır; gerçek kişi ve kurumlarla ilgisi yoktur.
| Kaynak | Açıklama | Örnek |
|---|---|---|
/kullanicilar | 50 kullanıcı — ad, e-posta, telefon, adres, firma bağlantısı | Görüntüle |
/firmalar | 25 firma — unvan, vergi no, IBAN, sektör, adres | Görüntüle |
/urunler | 62 ürün — fiyat (TL), KDV, stok, barkod, puan | Görüntüle |
/kategoriler | 10 ürün kategorisi | Görüntüle |
/siparisler | 80 sipariş — kalemler, tutarlar, kargo takibi, durum | Görüntüle |
/faturalar | 61 fatura — e-arşiv/e-fatura, matrah, KDV | Görüntüle |
/gonderiler | 20 blog yazısı — başlık, içerik, etiketler | Görüntüle |
/yorumlar | ~100 yorum — gönderi ve kullanıcı bağlantılı | Görüntüle |
/gorevler | 30 yapılacak görev — öncelik, son tarih, durum | Görüntüle |
İngilizce takma adlar da çalışır: /users, /companies, /products, /categories, /orders, /invoices, /posts, /comments, /todos.
Sorgu Özellikleri
| Özellik | Parametre | Örnek |
|---|---|---|
| Tekil kayıt | /{id} | /urunler/12 |
| Sayfalama | _sayfa, _limit | /siparisler?_sayfa=2&_limit=10 |
| Sıralama | _sirala, _yon (asc/desc) | /urunler?_sirala=fiyat&_yon=desc |
| Alan filtresi | alan=değer | /siparisler?durum=kargoda |
| İç içe alan filtresi | alan_altAlan=değer | /kullanicilar?adres_il=İzmir |
| Tam metin arama | q | /urunler?q=kahve |
| Zarflı yanıt | _zarf=1 | /urunler?_zarf=1 (toplam/sayfa bilgisiyle döner) |
Liste yanıtlarında toplam kayıt sayısı X-Toplam-Kayit (ve uyumluluk için X-Total-Count) başlığında döner. Varsayılan sayfa boyutu 20, en fazla 100'dür.
İlişkili Kayıtlar
GET /api/v1/kullanicilar/5/siparisler → kullanıcının siparişleri
GET /api/v1/kullanicilar/5/gonderiler → kullanıcının yazıları
GET /api/v1/gonderiler/3/yorumlar → yazının yorumları
GET /api/v1/firmalar/2/kullanicilar → firmanın çalışanları
GET /api/v1/kategoriler/1/urunler → kategorideki ürünler
GET /api/v1/siparisler/10/faturalar → siparişin faturası
Yazma İstekleri (Simülasyon)
POST, PUT, PATCH ve DELETE istekleri gerçekçi yanıtlarla simüle edilir; veri kalıcı olarak değişmez. Böylece formlarınızı ve istemci kodunuzu güvenle test edebilirsiniz.
POST /api/v1/gorevler → 201, gövde + yeni id ile döner
PUT /api/v1/gorevler/7 → 200, gönderilen gövde ile döner
PATCH /api/v1/gorevler/7 → 200, mevcut kayıt + değişiklikler
DELETE /api/v1/gorevler/7 → 200, {"silindi": true, ...}
Kod Örnekleri
JavaScript (fetch)
const yanit = await fetch('https://www.ornekfirma.com/api/v1/urunler?_limit=5');
const urunler = await yanit.json();
console.log(urunler[0].ad, urunler[0].fiyat + ' TL');
cURL
curl "https://www.ornekfirma.com/api/v1/siparisler?durum=kargoda&_limit=3"
PHP
$kullanicilar = json_decode(
file_get_contents('https://www.ornekfirma.com/api/v1/kullanicilar'),
true
);
echo $kullanicilar[0]['ad'];
Python
import requests
firmalar = requests.get("https://www.ornekfirma.com/api/v1/firmalar").json()
print(firmalar[0]["unvan"])
Kullanım Koşulları
- API tamamen ücretsizdir; ticari ve ticari olmayan projelerde, eğitim materyallerinde ve belgelerde serbestçe kullanılabilir.
- Tüm veriler kurgusaldır. Ad, telefon, IBAN, vergi numarası gibi alanların gerçek kişi ya da kurumlarla benzerliği tesadüftür.
- Adil kullanım beklenir; otomatik yoğun trafik (saniyede onlarca istek) yerine yanıtları önbelleğe almanızı rica ederiz.
- Hizmet, Türk SEM tarafından toplumsal fayda amacıyla sunulur; kesintisiz çalışma garantisi verilmez.