01Metrikler
| Metrik | Hedef | Nasıl ölçülür |
|---|---|---|
| Açık kritik hata | 0 | Hata takip sistemi |
| Test kapsamı | Kritik akışları kapsıyor | Test raporları |
| Ortalama düzeltme süresi | Azalan eğilim | Hata kayıtları |
| Güncel olmayan bağımlılık | Kritik olan yok | Bağımlılık tarama raporu |
02Raporlama
Ölçümler işten önce ve sonra aynı yöntemle alınır; fark kısa bir raporla paylaşılır ve izleme sürdürülür.
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 |
04Eyüpsultan için çalışma düzeni
Eyüpsultan'ın PTT verisindeki 29 yerleşim kaydı 8 farklı posta koduna dağılır.
Mesafe yazılım işinin önünde engel değildir: Eyüpsultan'daki ekiplerle görüntülü görüşme, ekran paylaşımı ve test ortamı bağlantısıyla çalışılır; cihaz kurulumu veya saha keşfi gerekirse yerinde ziyaret planlanır.
Aynı ildeki Bağcılar, Kadıköy ve Üsküdar ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
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.
05Hangi 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.
Entegrasyon talepleri tek tek karşılandığında
Standart bir API ve dokümantasyon, her iş ortağı için ayrı geliştirme yapma ihtiyacını azaltır.
06Planlama notları
- hata kodu standardı.
- OpenAPI dokümantasyonu
- kimlik doğrulama (API anahtarı, OAuth 2.0)
07API dokümantasyonu hangi işletmelerde kullanılır?
- Kurumsal BT ekipleri
- İş ortağı ekosistemi olan firmalar
- Veri sağlayıcıları
- Platform kuran girişimler
08İş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.
09Örnek planlama hesabı
Örnek: otomasyonla kazanılan süre
- Günlük tekrarlanan iş
- 94
- İş başına süre
- 1 dk
- Aylık süre (22 iş günü)
- 34,5 saat
- Otomasyon sonrası doğrulama payı (%19)
- 6,5 saat
Not: örnek hesaptır; kesin plan analizde çıkar.
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.
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.
Eyüpsultan'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.
İstanbul 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.
Sonuçlar ne zaman görülür?
Teknik ölçümler iş biter bitmez görülür; arama görünürlüğü gibi dış etkenlere bağlı sonuçlar ise zaman içinde izlenir ve garanti edilmez.
Hangi araçlarla ölçüyorsunuz?
İşe göre Search Console, Lighthouse/PageSpeed Insights, uptime ve log izleme araçları ile sunucu metrikleri kullanılır.
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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Eyüpsultan'da ilgili hizmetler
İstanbul içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- SDK
- OAuth 2.0
- İstanbul
- Eyüpsultan