01Adımlar
1. Kod, erişimler ve ortamlar üzerinde durum tespiti yapmak
Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.
2. Riskleri ve öncelikleri listelemek
Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.
3. Test ortamı ve sürüm kontrolünü düzene sokmak
Bu adımın çıktısı kısa bir notla paylaşılır.
4. Kritik hataları ve güvenlik açıklarını gidermek
Bu adımda yapılan her değişiklik kayıt altına alınır.
5. Testleri ve dokümantasyonu tamamlamak
Bu adımın çıktısı kısa bir notla paylaşılır.
6. Düzenli bakım ve geliştirme planına geçmek
Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.
02Dikkat noktaları
- Kaçınılması gereken: sürüm kontrolü kullanmamak
- Kaçınılması gereken: tüm sistemi aynı anda yeniden yazmaya kalkmak
- Kaçınılması gereken: hatayı yeniden üretmeden kod değiştirmek
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 |
04Bayındır'da API dokümantasyonu
Bayındır'ın PTT verisindeki 59 yerleşim kaydı 3 farklı posta koduna dağılır.
Mesafe yazılım işinin önünde engel değildir: Bayındır'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 Ödemiş, Foça ve Çeşme 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.
05Planlama notları
- hata kodu standardı.
- sürümleme stratejisi
- OpenAPI dokümantasyonu
06Kapsamı ve maliyeti etkileyenler
- beklenen trafik ve ölçekleme ihtiyacı
- uç nokta sayısı ve veri modelinin karmaşıklığı
- dokümantasyon ve geliştirici portalı kapsamı
- izleme ve destek düzeyi
07Örnek kapsam hesabı
Örnek: otomasyonla kazanılan süre
- Günlük tekrarlanan iş
- 234
- İş başına süre
- 3 dk
- Aylık süre (22 iş günü)
- 257,4 saat
- Otomasyon sonrası doğrulama payı (%13)
- 33,5 saat
Not: örnek hesaptır; kesin plan analizde çıkar.
SSSSık sorulan sorular
Bu adımları kendim uygulayabilir miyim?
Bazı adımlar teknik bilgiyle yapılabilir; yedekleme, sürüm uyumu ve canlı ortam değişiklikleri ise deneyim gerektirir. Kendin yap mı uzman mı sayfasında ayrımı anlattık.
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.
İzmir 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.
Adımların sırası değişebilir mi?
Mevcut duruma göre değişebilir; ancak yedek ve test adımları her zaman önce gelir.
Bayındır'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.
API'yi kimlerin kullandığını nasıl izleriz?
Her istemciye ayrı anahtar veya OAuth istemcisi verilir; kullanım, hata ve kota tüketimi istemci bazında raporlanı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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Bayındır'da ilgili hizmetler
İzmir içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- webhook
- OpenAPI
- OAuth 2.0
- İzmir
- Bayındır