01Sık yapılan hatalar
Test ortamı olmadan canlıda düzeltme yapmak
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
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
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
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
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
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 |
04Hangi durumlarda gündeme gelir?
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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
05Andırın'da destek
Andırın, Kahramanmaraş iline bağlı bir ilçedir ve PTT adres verisine göre 57 mahalleden oluşur. Birden fazla ilçede ekibi veya şubesi olan işletmelerde API dokümantasyonu için kullanıcı rolleri, şube bazlı görünürlük ve merkezi raporlar birlikte planlanır.
Andırın'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.
Kahramanmaraş genelinde Ekinözü, Afşin ve Nurhak gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.
Sorunu kısa bir notla ve ekran görüntüsüyle WhatsApp'tan iletin; API dokümantasyonu için ön değerlendirme yapalım. Telefon: 0540 003 19 81.
SSSSık sorulan sorular
Kahramanmaraş dışındaki işletmelere de hizmet veriyor musunuz?
Evet. Askadar Yazılım, Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışır; gerektiğinde yerinde çalışma ayrıca planlanır.
Andırın'dan yazıyorum; toplantılar nasıl yapılıyor?
Toplantılar görüntülü yapılır ve ekran paylaşımıyla ilerler. Cihaz kurulumu, saha incelemesi veya ekip eğitimi gibi yerinde bulunmayı gerektiren adımlar ayrıca planlanı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.
REST mi GraphQL mi?
Kaynak bazlı, önbelleğe uygun ve geniş araç desteği gereken çoğu iş API'sinde REST yeterlidir. İstemcilerin çok farklı veri kombinasyonları istediği ürünlerde GraphQL değerlendirilir.
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.
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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Andırın'da ilgili hizmetler
Kahramanmaraş içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OpenAPI
- Swagger
- SDK
- Kahramanmaraş
- Andırın