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
06Hangi durumlarda gündeme gelir?
Verinizi iş ortaklarına açmak istediğinizde
API dokümantasyonu ile veri, yetki ve kota kontrolüyle güvenli biçimde dış sistemlere sunulur.
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.
07Kapsamı ve maliyeti etkileyenler
- dokümantasyon ve geliştirici portalı kapsamı
- kimlik doğrulama ve yetki yapısı
- izleme ve destek düzeyi
- kota, faturalama ve kullanım ölçümü
08API dokümantasyonu hangi işletmelerde kullanılır?
- İş ortağı ekosistemi olan firmalar
- Yazılım şirketleri
- Platform kuran girişimler
- Kurumsal BT ekipleri
09Pülümür'de planlama
Pülümür'ün PTT verisindeki 130 yerleşim kaydı 2 farklı posta koduna dağılır.
Pülümür'de 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.
Tunceli genelinde Tunceli Merkez, Tunceli Ovacık ve Hozat 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
Pülümür'de yüz yüze görüşebilir miyiz?
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.
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.
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.
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.
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.
Tunceli dışındaki işletmelere de hizmet veriyor musunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; Doğu Anadolu Bölgesi dahil tüm bölgelerde süreç aynı düzenle yürür.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Pülümür'de ilgili hizmetler
Tunceli 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
- OAuth 2.0
- Tunceli
- Pülümür