API dokümantasyonu — API Türkiye

Başlangıç

Temel API adresi https://api.apiturkiye.com şeklindedir. Üretim anahtarınızı müşteri panelinde paketiniz onaylandıktan sonra oluşturabilirsiniz.

curl "https://api.apiturkiye.com/v1/provinces?limit=50" \
  -H "X-API-Key: apt_live_..."

Kimlik doğrulama

Her istekte anahtarınızı X-API-Key başlığında gönderin. Anahtarı tarayıcı koduna, Git deposuna veya loglara yazmayın. Şüpheli durumda panelden iptal edip yenisini oluşturun.

X-API-Key: apt_live_your_api_key

Sabit kimlikler

Her adres nesnesindeki stableId, aynı kaynak kimliği yeni katalog sürümünde tekrar geldiğinde değişmez. Entegrasyonlar kalıcı referans olarak stableId saklamalıdır. Kaynak code alanı eşleştirme amacıyla korunur; dış kapı yanıtındaki sayısal id ise yalnız aktif katalog sürümüne aittir.

{
  "stableId": "apt_v1_dor_...",
  "id": "88214",
  "code": "72503885",
  "doorNumber": "2",
  "label": ""
}

Sayfalama

limit değeri 1–100 arasındadır. Sonraki sayfa için yanıttaki meta.nextCursor değerini cursor olarak gönderin.

{
  "data": [...],
  "meta": { "nextCursor": "..." }
}

Uç noktalar

POST/v1/addresses/validate

GET/v1/provinces

GET/v1/provinces/{code}/districts

GET/v1/districts/{code}/neighborhoods

GET/v1/neighborhoods/{code}/streets

GET/v1/streets/{code}/buildings

Hata yanıtları

401 eksik veya geçersiz anahtar, 403 yetersiz kapsam, 400 geçersiz parametre, 429 hız limiti (bkz. Retry-After), 503 katalog geçici olarak erişilemez anlamına gelir.

{
  "error": {
    "code": "invalid_api_key",
    "message": "Geçerli bir X-API-Key başlığı zorunludur."
  }
}