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
Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.
4. Kritik hataları ve güvenlik açıklarını gidermek
Adım tamamlanmadan bir sonrakine geçilmez; sonuç doğrulanır.
5. Testleri ve dokümantasyonu tamamlamak
Bu adımda yapılan her değişiklik kayıt altına alınır.
6. Düzenli bakım ve geliştirme planına geçmek
Bu adımda yapılan her değişiklik kayıt altına alınır.
02Dikkat noktaları
- Kaçınılması gereken: yapılan değişiklikleri belgelememek
- Kaçınılması gereken: tüm sistemi aynı anda yeniden yazmaya kalkmak
- Kaçınılması gereken: test ortamı olmadan canlıda düzeltme yapmak
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 |
04Maden için çalışma düzeni
Maden'in PTT verisindeki 114 yerleşim kaydı 2 farklı posta koduna dağılır.
Mesafe yazılım işinin önünde engel değildir: Maden'deki 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.
Elazığ genelinde Sivrice, Elazığ Merkez ve Alacakaya gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.
Maden bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
05Kapsamı ve maliyeti etkileyenler
- dokümantasyon ve geliştirici portalı kapsamı
- beklenen trafik ve ölçekleme ihtiyacı
- uç nokta sayısı ve veri modelinin karmaşıklığı
- kota, faturalama ve kullanım ölçümü
06Rakamlarla örnek bir senaryo
Örnek: otomasyonla kazanılan süre
- Günlük tekrarlanan iş
- 394
- İş başına süre
- 3 dk
- Aylık süre (22 iş günü)
- 433,4 saat
- Otomasyon sonrası doğrulama payı (%12)
- 52 saat
Not: örnek hesaptır; kesin plan analizde çıkar.
SSSSık sorulan sorular
Maden'de 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 ö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.
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'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.
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.
Sadece Elazığ 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.
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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu sonuçların ölçülmesiHangi metriklerle ölçülür
- API dokümantasyonu sonrası bakımİşlem sonrası kalıcılık
- API dokümantasyonu kontrol listesiAdım adım kontrol listesi
- API dokümantasyonu fiyatlarıMaliyeti belirleyenler
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
Maden'de ilgili hizmetler
Elazığ içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- SDK
- OpenAPI
- Elazığ
- Maden