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
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
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 |
04İş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.
- Webhook teslim hataları ve yeniden denemeler raporlanır.
05Planlama notları
- oran sınırı ve kota
- webhook imza doğrulaması
- sürümleme stratejisi
06Hangi durumlarda gündeme gelir?
Verinizi iş ortaklarına açmak istediğinizde
API dokümantasyonu ile veri, yetki ve kota kontrolüyle güvenli biçimde dış sistemlere sunulur.
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.
07Şiran'da destek
Şiran'ın PTT verisindeki 101 yerleşim kaydı 3 farklı posta koduna dağılır.
Mesafe yazılım işinin önünde engel değildir: Şiran'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 Kelkit, Kürtün ve Gümüşhane Merkez ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
Şiran bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
SSSSık sorulan sorular
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.
En pahalıya mal olan hata hangisi?
Yedeksiz müdahale; geri dönüşü olmayan veri kaybı en maliyetli sonuçtur.
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.
Gümüşhane 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.
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.
Şiran'da yüz yüze görüşebilir miyiz?
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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu öncesi hazırlıkErişimler, yedek ve hazırlık
- API dokümantasyonu tespit ve analizSorunun nasıl tespit edildiği
- API dokümantasyonu kontrol listesiAdım adım kontrol listesi
- API dokümantasyonu nasıl yapılırAdım adım uygulama
- API dokümantasyonu sorunları ve belirtileriHangi belirti neyi gösterir
Şiran'da ilgili hizmetler
Gümüşhane içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- rate limit
- OpenAPI
- Gümüşhane
- Şiran