REST API uç noktaları
Caution
Demo sayfası - Bu sayfa, çok sekmeli dokümantasyon özelliğini göstermek için hazırlanmış bir demo sayfasıdır. İçerik yalnızca örnekleme amaçlıdır.
REST API’miz, verilere erişmek ve veriler üzerinde işlem yapmak için uç noktalar sunar. Tüm uç noktalar verileri JSON biçiminde döndürür.
Temel URL
Tüm API istekleri aşağıdaki temel URL’ye gönderilmelidir:
https://api.example.com/v1Kullanıcı uç noktaları
Tüm kullanıcıları getirme
GET /usersTüm kullanıcıların listesini döndürür. Sayfalama parametrelerini destekler.
Sorgu parametreleri:
| Parametre | Tür | Açıklama |
|---|---|---|
| page | integer | Sayfa numarası (varsayılan: 1) |
| limit | integer | Sayfa başına kayıt sayısı (varsayılan: 50, en fazla: 100) |
| sort | string | Sıralamada kullanılacak alan (örneğin “name”, “created_at”) |
Yanıt:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Kullanıcıyı ID ile getirme
GET /users/{id}ID’ye göre tek bir kullanıcı döndürür.
Yanıt:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Ürün uç noktaları
Tüm ürünleri getirme
GET /productsTüm ürünlerin listesini döndürür. Filtrelemeyi ve sayfalamayı destekler.
Sorgu parametreleri:
| Parametre | Tür | Açıklama |
|---|---|---|
| category | string | Kategoriye göre filtreler |
| min_price | number | En düşük fiyata göre filtreler |
| max_price | number | En yüksek fiyata göre filtreler |
| page | integer | Sayfa numarası (varsayılan: 1) |
| limit | integer | Sayfa başına kayıt sayısı (varsayılan: 50, en fazla: 100) |
Yanıt:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Hata yönetimi
Tüm uç noktalar standart HTTP durum kodlarını kullanır ve uygun olduğunda ayrıntılı hata mesajları içerir:
| Durum kodu | Açıklama |
|---|---|
| 200 | OK - İstek başarılı oldu |
| 400 | Bad Request - Geçersiz parametreler |
| 401 | Unauthorized - Kimlik doğrulama gerekli |
| 403 | Forbidden - Yetki yetersiz |
| 404 | Not Found - Kaynak bulunamadı |
| 429 | Too Many Requests - İstek sınırı aşıldı |
| 500 | Internal Server Error - Sunucu hatası oluştu |
Hata yanıtları, neyin yanlış gittiğini açıklayan bir mesaj içerir:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}