01Kontrol edilen başlıklar
- Sunucu ve uygulama logları
- Search Console ve analitik verileri (web işlerinde)
- Lighthouse ve PageSpeed ölçümleri
- Sunucu kaynak kullanımı (işlemci, bellek, disk)
- Sürüm, bağımlılık ve güvenlik güncelleme durumu
- Belirti kontrolü: kodu yazan kişiye veya firmaya ulaşılamaması
- Belirti kontrolü: kütüphane ve çatı sürümlerinin desteğinin bitmesi
02Rapor içeriği
- Bulgular ve kanıtlar
- Önceliklendirilmiş sorun listesi
- Önerilen çözüm ve etkisi
- Riskler ve ön koşullar
- Uygulama planı
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 |
04Analizde kullanılan ölçütler
| 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 |
05İşletim ve bakım ipuçları
- Webhook teslim hataları ve yeniden denemeler raporlanır.
- Eski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
- Hata oranı ve yanıt süresi uç nokta bazında izlenir.
06Planlama notları
- webhook imza doğrulaması
- hata kodu standardı.
- kimlik doğrulama (API anahtarı, OAuth 2.0)
07Ayaş'ta uzaktan analiz
PTT kayıtlarında Ayaş ilçesine bağlı 33 yerleşim bulunur. 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.
Mesafe yazılım işinin önünde engel değildir: Ayaş'taki 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 Çubuk, Akyurt ve Çankaya ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
Ayaş bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
SSSSık sorulan sorular
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 Ankara 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.
Ayaş'ta bulunuyorum, yerinde görüşme mümkün mü?
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.
Analiz için sistemime tam erişim vermem gerekir mi?
Gereken erişim işe göre sınırlanır; mümkünse geçici ve yetkisi kısıtlı bir kullanıcı açılması önerilir.
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.
Analiz raporunu başka bir ekip kullanabilir mi?
Evet; rapor bulguları, kanıtları ve önerileri içerdiği için başka bir ekip de uygulamada kullanabilir.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu fiyatlarıMaliyeti belirleyenler
- API dokümantasyonu sık yapılan hatalarKaçınılması gerekenler
- API dokümantasyonu sonuçların ölçülmesiHangi metriklerle ölçülür
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonuTespit, uygulama ve teslim
Ayaş'ta ilgili hizmetler
Ankara içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- SDK
- Swagger
- OAuth 2.0
- Ankara
- Ayaş