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
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
Sürüm kontrolü kullanmamak
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
Tüm sistemi aynı anda yeniden yazmaya kalkmak
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
Yapılan değişiklikleri belgelememek
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
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 |
04Planlama notları
- sürümleme stratejisi
- OpenAPI dokümantasyonu
- kimlik doğrulama (API anahtarı, OAuth 2.0)
05API dokümantasyonu hangi işletmelerde kullanılır?
- Kurumsal BT ekipleri
- Platform kuran girişimler
- İş ortağı ekosistemi olan firmalar
- Veri sağlayıcıları
06Kapsamı ve maliyeti etkileyenler
- uç nokta sayısı ve veri modelinin karmaşıklığı
- kimlik doğrulama ve yetki yapısı
- kota, faturalama ve kullanım ölçümü
- izleme ve destek düzeyi
07Amasra'da destek
Amasra'nın PTT verisindeki 96 yerleşim kaydı 2 farklı posta koduna dağılır.
Amasra'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.
Bartın genelinde Bartın Merkez, Kurucaşile ve Ulus 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
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.
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'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.
En pahalıya mal olan hata hangisi?
Yedeksiz müdahale; geri dönüşü olmayan veri kaybı en maliyetli sonuçtur.
Amasra'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 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.
Sadece Bartın için mi çalışıyorsunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Bartın de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanır.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Amasra'da ilgili hizmetler
Bartın içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- webhook
- OAuth 2.0
- Bartın
- Amasra