API Dokümantasyonu

Başlarken

API'ımızla tanışmak için bu kılavuzu takip ederek ilk isteğinizi nasıl yapacağınızı öğrenin.

Temel URL

Tüm istekler aşağıdaki temel adrese yapılmalıdır: https://api.ornek.com/v1/

İstek cURL 
curl https://api.ornek.com/v1/durum
Yanıt JSON 
{
  "durum": "calisiyor",
  "versiyon": "1.0.0",
  "sunucuZamani": "2025-04-16T08:07:31Z"
}

Genel Bakış

RESTful API'ımız ile şunları yapabilirsiniz:

  • Kullanıcı oluşturma ve yönetme
  • Sipariş ve ödeme işlemleri
  • Ürün bilgilerini görüntüleme ve güncelleme
  • Rapor ve analiz oluşturma

API Anahtarları

API'ye erişim, API anahtarları ile sağlanır. Her istekte `Authorization` başlığına anahtarınızı ekleyin.

Önemli: API anahtarlarınızı güvende tutun! Hiçbir zaman herkese açık ortamlarda paylaşmayın.

Örnek İstek cURL 
curl https://api.ornek.com/v1/kullanicilar \
  -H "Authorization: Bearer SENIN_API_ANAHTARIN"

Yetkilendirme Yöntemleri

Bearer Token

`Authorization: Bearer ` başlığı ile anahtarınızı gönderin.

Sorgu Parametresi

Test amaçlı, `?api_key=` şeklide de ekleyebilirsiniz.

Bearer Token Örneği cURL 
curl https://api.ornek.com/v1/kullanicilar \
  -H "Authorization: Bearer sk_test_ABCDE12345"
Sorgu Parametresi Örneği cURL 
curl "https://api.ornek.com/v1/kullanicilar?api_key=sk_test_ABCDE12345"

İstek Formatı

Tüm istekler HTTPS ile yapılmalı ve aşağıdaki başlıkları içermelidir:

  • Content-Type: application/json
  • Authorization: Bearer YOUR_API_KEY
  • Accept: application/json
POST Örneği cURL 
curl https://api.ornek.com/v1/kullanicilar \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "isim": "Ali Veli",
    "email": "[email protected]"
  }'

Sorgu Parametreleri

Listeleme uç noktalarında sık kullanılan parametreler:

  • limit: Döndürülecek kayıt sayısı (varsayılan: 10, maks: 100)
  • offset: Atlanacak kayıt sayısı
  • sort: Sıralama yapılacak alan
  • order: Sıralama yönü (asc/desc)
Örnek İstek cURL 
curl "https://api.ornek.com/v1/kullanicilar?limit=20&offset=0&sort=olusturma_tarihi&order=desc" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sayfalandırma

Liste uç noktaları, limit ve offset parametreleriyle sayfalandırmayı destekler.

Yanıt, aşağıdaki meta bilgileri içerir:

  • total: Toplam kayıt sayısı
  • pages: Toplam sayfa sayısı
  • current_page: Geçerli sayfa numarası
  • per_page: Sayfa başına kayıt sayısı
Yanıt Örneği JSON 
{
  "data": [...],
  "meta": {
    "total": 100,
    "pages": 5,
    "current_page": 1,
    "per_page": 20
  }
}