01Öncesi kontrol listesi
- Kaynak kod deposu
- Sunucu ve veritabanı erişimi
- Varsa mevcut dokümanlar ve hata kayıtları
- Uygulamanın kritik iş akışlarının listesi
- Tam yedek alındı ve doğrulandı
02Sonrası kontrol listesi
- Açık kritik hata: 0
- Test kapsamı: Kritik akışları kapsıyor
- Ortalama düzeltme süresi: Azalan eğilim
- Güncel olmayan bağımlılık: Kritik olan yok
- Formlar, ödeme ve kritik işlemler denendi
- Yedekleme ve izleme çalışıyor
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?
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
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.
05Kapsamı ve maliyeti etkileyenler
- kimlik doğrulama ve yetki yapısı
- izleme ve destek düzeyi
- dokümantasyon ve geliştirici portalı kapsamı
- kota, faturalama ve kullanım ölçümü
06API dokümantasyonu hangi işletmelerde kullanılır?
- Kurumsal BT ekipleri
- İş ortağı ekosistemi olan firmalar
- Veri sağlayıcıları
- Platform kuran girişimler
07Planlama notları
- kimlik doğrulama (API anahtarı, OAuth 2.0)
- oran sınırı ve kota
- hata kodu standardı.
08İşletim ve bakım ipuçları
- Eski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
- Anahtarların sızıntıya karşı taranması ve yenilenmesi planlanır.
- Dokümantasyon her sürümle birlikte güncellenir.
09Küre'de kontrol desteği
Küre'nin PTT verisindeki 168 yerleşim kaydı 2 farklı posta koduna dağılır.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Küre'deki işletmelerle ekran paylaşımlı demolar ve ortak bir proje panosu üzerinden çalışılır. Donanım kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.
Kastamonu genelinde Seydiler, Cide ve Kastamonu Merkez gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.
Küre bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
SSSSık sorulan sorular
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.
Kontrol listesini kendim uygulayabilir miyim?
Evet. Listede sorun görürseniz ekran görüntüsüyle birlikte bize iletebilirsiniz.
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.
Kontrol listesi ne sıklıkla uygulanmalı?
Her büyük değişiklik öncesi ve sonrası; rutin kontroller için ayda bir yeterlidir.
Küre'den 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.
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.
Sadece Kastamonu 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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Küre'de ilgili hizmetler
Kastamonu 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
- SDK
- Kastamonu
- Küre