01İstenecek erişimler
- 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
02Tam yedek
İşe başlamadan önce dosya ve veritabanının tam yedeği alınır ve yedeğin açıldığı doğrulanır. Yedek, çalışılan sunucudan farklı bir yerde saklanır.
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 |
04Bakım penceresi
Canlı ortamı etkileyecek adımlar, kullanımın en düşük olduğu saatlere planlanır ve önceden duyurulur; gerekirse ziyaretçilere bakım sayfası gösterilir.
05Hazırlık kontrol listesi
- Erişim bilgileri tek bir güvenli listede
- Son değişikliklerin tarihi ve açıklaması
- Kritik sayfa ve işlemlerin listesi
- Sorumlu kişinin iletişim bilgisi
06Planlama notları
- oran sınırı ve kota
- sürümleme stratejisi
- kimlik doğrulama (API anahtarı, OAuth 2.0)
07API dokümantasyonu hangi işletmelerde kullanılır?
- Kurumsal BT ekipleri
- Platform kuran girişimler
- İş ortağı ekosistemi olan firmalar
- Veri sağlayıcıları
08Hangi 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.
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
09İşletim ve bakım ipuçları
- Eski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
- Hata oranı ve yanıt süresi uç nokta bazında izlenir.
- Webhook teslim hataları ve yeniden denemeler raporlanır.
10Borçka'da planlama
Borçka'nın PTT verisindeki 76 yerleşim kaydı 2 farklı posta koduna dağılır.
Borçka'da bulunan bir işletmeyle çalışırken toplantılar görüntülü yapılır, her aşama test ortamında paylaşılır ve geri bildirimler ortak panoda toplanır; yerinde bulunmak gereken kurulum ve eğitim adımları ayrıca planlanır.
Aynı ildeki Artvin Merkez, Ardanuç ve Hopa 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.
SSSSık sorulan sorular
Yedeği kim alır?
Erişim verildiyse yedeği biz alırız; mevcut hosting yedeği varsa ayrıca doğrulanı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.
Borçka'da bulunuyorum, yerinde görüşme mümkün mü?
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.
Sadece Artvin için mi çalışıyorsunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; Karadeniz Bölgesi dahil tüm bölgelerde süreç aynı düzenle yürür.
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.
Erişim bilgilerini nasıl paylaşmalıyım?
Parolaları açık metin olarak e-postayla göndermek yerine geçici kullanıcı açmak veya güvenli bir parola paylaşım aracı kullanmak önerilir; iş bitince erişim kapatılı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
Borçka'da ilgili hizmetler
Artvin içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- Swagger
- OAuth 2.0
- webhook
- Artvin
- Borçka