01Sık yapılan hatalar
Test ortamı olmadan canlıda düzeltme yapmak
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
Hatayı yeniden üretmeden kod değiştirmek
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
Sürüm kontrolü kullanmamak
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
Tüm sistemi aynı anda yeniden yazmaya kalkmak
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
Yapılan değişiklikleri belgelememek
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
02Doğru yaklaşım
- Önce yedek, sonra tespit
- Değişiklikleri test ortamında denemek
- Her adımı kayıt altına almak
- Sonucu ölçümle doğrulamak
03Belirti, neden ve çözüm
| Belirti | Olası neden | Çözüm |
|---|---|---|
| İş ortakları API'yi yanlış kullanıyor | Dokümantasyon eksik veya güncel değil | OpenAPI şeması, örnek istekler ve sürüm notları |
| API yoğunlukta yavaşlıyor | Kota ve önbellek yok, sorgular optimize değil | Oran sınırı, önbellek ve sorgu iyileştirme |
| Webhook bildirimleri kayboluyor | Yeniden deneme ve teslim kaydı yok | İmzalı webhook, kuyruk ve teslim logu |
| Eski sürümü kullananlar bozuluyor | Sürümleme ve geçiş takvimi yok | Sürümlü uç noktalar ve duyurulu kullanım dışı bırakma |
04İşletim ve bakım ipuçları
- Hata oranı ve yanıt süresi uç nokta bazında izlenir.
- Anahtarların sızıntıya karşı taranması ve yenilenmesi planlanır.
- Eski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
05Planlama notları
- kimlik doğrulama (API anahtarı, OAuth 2.0)
- webhook imza doğrulaması
- hata kodu standardı.
06Hangi durumlarda gündeme gelir?
Kılavuz gerektiğinde
Kılavuz, API dokümantasyonu projesinde kapsamın başında konuşulan başlıklardandır; analizde kimin kullanacağı ve nasıl çalışacağı netleştirilir.
Verinizi iş ortaklarına açmak istediğinizde
API dokümantasyonu ile veri, yetki ve kota kontrolüyle güvenli biçimde dış sistemlere sunulur.
07Durağan'da destek
Durağan'ın PTT verisindeki 171 yerleşim kaydı 2 farklı posta koduna dağılır.
Durağan'da bulunan bir işletmeyle çalışırken toplantılar görüntülü yapılır, her aşama test ortamında paylaşılır ve geri bildirimler ortak panoda toplanır; yerinde bulunmak gereken kurulum ve eğitim adımları ayrıca planlanır.
Aynı ildeki Erfelek, Türkeli ve Gerze ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
Durağan bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
SSSSık sorulan sorular
Sadece Sinop için mi çalışıyorsunuz?
Evet. Askadar Yazılım, Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışır; gerektiğinde yerinde çalışma ayrıca planlanır.
API dokümantasyonu öncesinde neleri hazırlamalıyım?
Kaynak kod deposu, sunucu ve veritabanı erişimi ve varsa mevcut dokümanlar ve hata kayıtları işi hızlandırır.
Bir hata yaptım, ne yapmalıyım?
Daha fazla değişiklik yapmadan mevcut durumu kaydedin, yedeğiniz varsa saklayın ve uzmana ulaşın. Acil durumlar için ayrı bir kontrol listesi hazırladık.
API dokümantasyonu sırasında site veya uygulama kapanır mı?
Hazırlık test ortamında yapılır; canlı ortamdaki değişiklik önceden haber verilen kısa bir bakım penceresinde uygulanır.
En pahalıya mal olan hata hangisi?
Yedeksiz müdahale; geri dönüşü olmayan veri kaybı en maliyetli sonuçtur.
Durağan'da yüz yüze görüşebilir miyiz?
İşin büyük bölümü uzaktan yürür: ilk görüşme telefonla, sonraki toplantılar görüntülü yapılır. Kurulum ya da eğitim gerekiyorsa yerinde çalışma takvime eklenir.
API'yi kimlerin kullandığını nasıl izleriz?
Her istemciye ayrı anahtar veya OAuth istemcisi verilir; kullanım, hata ve kota tüketimi istemci bazında raporlanır.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Durağan'da ilgili hizmetler
Sinop içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- SDK
- webhook
- OpenAPI
- Sinop
- Durağan