01Öncesi kontrol listesi
- Kaynak kod deposu
- Sunucu ve veritabanı erişimi
- Varsa mevcut dokümanlar ve hata kayıtları
- Uygulamanın kritik iş akışlarının listesi
- Tam yedek alındı ve doğrulandı
02Sonrası kontrol listesi
- Açık kritik hata: 0
- Test kapsamı: Kritik akışları kapsıyor
- Ortalama düzeltme süresi: Azalan eğilim
- Güncel olmayan bağımlılık: Kritik olan yok
- Formlar, ödeme ve kritik işlemler denendi
- Yedekleme ve izleme çalışıyor
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.
- Dokümantasyon her sürümle birlikte güncellenir.
- Eski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
05Hangi durumlarda gündeme gelir?
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.
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.
06API dokümantasyonu hangi işletmelerde kullanılır?
- Platform kuran girişimler
- İş ortağı ekosistemi olan firmalar
- Kurumsal BT ekipleri
- Veri sağlayıcıları
07Dicle'de kontrol desteği
Dicle'nin PTT verisindeki 49 yerleşim kaydı 1 farklı posta koduna dağılır. 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; Dicle'deki 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.
Diyarbakır genelinde Hani, Çüngüş ve Çermik gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.
Dicle bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
SSSSık sorulan sorular
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.
Sadece Diyarbakır için mi çalışıyorsunuz?
Askadar Yazılım 81 ilde uzaktan çalışır; Diyarbakır de bunlardan biridir. Yerinde iş gerektiğinde ziyaret planlanır.
Kontrol listesi ne sıklıkla uygulanmalı?
Her büyük değişiklik öncesi ve sonrası; rutin kontroller için ayda bir yeterlidir.
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.
Dicle'de yüz yüze görüşebilir miyiz?
Analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; donanım kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.
Kontrol listesini kendim uygulayabilir miyim?
Evet. Listede sorun görürseniz ekran görüntüsüyle birlikte bize iletebilirsiniz.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
- API dokümantasyonu fiyatlarıMaliyeti belirleyenler
- API dokümantasyonu: kendin yap mı, uzman mı?Kendi yapılabilenler ve uzman gerektirenler
- API dokümantasyonu sorunları ve belirtileriHangi belirti neyi gösterir
- API dokümantasyonu sonuçların ölçülmesiHangi metriklerle ölçülür
- API dokümantasyonu sık yapılan hatalarKaçınılması gerekenler
Dicle'de ilgili hizmetler
Diyarbakır içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OAuth 2.0
- OpenAPI
- webhook
- Diyarbakır
- Dicle