01Sık yapılan hatalar
Test ortamı olmadan canlıda düzeltme yapmak
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
Hatayı yeniden üretmeden kod değiştirmek
Çözümü basittir ama sonradan düzeltmek iş yükünü katlar.
Sürüm kontrolü kullanmamak
Sonucu hemen görülmeyebilir; ancak birkaç gün içinde veri kaybı veya kesinti olarak ortaya çıkar.
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
Bu hata çoğu zaman geri dönüşü zor bir durum yaratır; önce yedek ve test ortamı şarttır.
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ı
- 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.
- Dokümantasyon her sürümle birlikte güncellenir.
05Hangi durumlarda gündeme gelir?
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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
06Sivrihisar'da destek
Sivrihisar, Eskişehir iline bağlı bir ilçedir ve PTT adres verisine göre 78 mahalleden oluşur. Büyükşehirlerde merkez ve şube yapısıyla çalışan işletmeler için API dokümantasyonu tasarımında merkez-şube yetki yapısı ve birleşik raporlama öne çıkar.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Sivrihisar'daki 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.
Eskişehir genelinde Seyitgazi, Beylikova ve Tepebaşı 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
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.
Eskişehir dışındaki işletmelere de hizmet veriyor musunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; İç Anadolu Bölgesi dahil tüm bölgelerde süreç aynı düzenle yürür.
En pahalıya mal olan hata hangisi?
Yedeksiz müdahale; geri dönüşü olmayan veri kaybı en maliyetli sonuçtur.
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.
Sivrihisar'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.
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.
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.
→İ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 sonrası bakımİşlem sonrası kalıcılık
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonu sonuçların ölçülmesiHangi metriklerle ölçülür
- API dokümantasyonu nasıl yapılırAdım adım uygulama
Sivrihisar'da ilgili hizmetler
Eskişehir içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OpenAPI
- SDK
- Swagger
- Eskişehir
- Sivrihisar