01İzleme
- Çalışma durumu (uptime) takibi
- Hata ve uyarı bildirimleri
- Aylık kısa durum raporu
02Güncelleme takvimi
- 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.
- Anahtarların sızıntıya karşı taranması ve yenilenmesi planlanır.
- Dokümantasyon her sürümle birlikte güncellenir.
- Webhook teslim hataları ve yeniden denemeler raporlanı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 |
04Bakım paketi
- Çalışma durumu ve hata izleme
- Güvenlik ve sürüm güncellemeleri
- Yedeklerin kontrolü ve geri yükleme denemesi
- Hata düzeltme
- Küçük geliştirmeler ve içerik değişiklikleri
- Aylık kısa durum raporu
05Planlama notları
- OpenAPI dokümantasyonu
- oran sınırı ve kota
- hata kodu standardı.
06Hangi 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.
07Kapsamı ve maliyeti etkileyenler
- kota, faturalama ve kullanım ölçümü
- kimlik doğrulama ve yetki yapısı
- uç nokta sayısı ve veri modelinin karmaşıklığı
- beklenen trafik ve ölçekleme ihtiyacı
08Marmaris'te bakım
Marmaris'in PTT verisindeki 30 yerleşim kaydı 1 farklı posta koduna dağılır. 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: Marmaris'teki 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.
Muğla genelinde Datça, Kavaklıdere ve Dalaman 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
Marmaris'te 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.
İş bittikten sonra destek alabilir miyim?
Evet. İhtiyaca göre aylık bakım veya olay bazlı destek planlanabilir.
Sadece Muğla için mi çalışıyorsunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Muğla de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanır.
Sorunun tekrar etmemesi için ne yapılır?
Kök neden giderilir, izleme ve uyarı kurulur, güncellemeler takvime bağlanı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.
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 ö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
Marmaris'te ilgili hizmetler
Muğla içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OpenAPI
- webhook
- Swagger
- Muğla
- Marmaris