Erfelek'te API dokümantasyonu

01Hangi durumlarda gerekir?

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.

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.

02Belirtiler

• Hataların tekrar tekrar ortaya çıkması
• Kütüphane ve çatı sürümlerinin desteğinin bitmesi
• Kodu yazan kişiye veya firmaya ulaşılamaması
• Dokümantasyon ve kurulum bilgisinin olmaması

03Hangi sistemlerde uygulanır?

• Yazılım şirketleri
• Veri sağlayıcıları
• Platform kuran girişimler
• Kurumsal BT ekipleri
• İş ortağı ekosistemi olan firmalar

04İş nasıl ilerler?

1. Kod, erişimler ve ortamlar üzerinde durum tespiti yapmak
2. Riskleri ve öncelikleri listelemek
3. Test ortamı ve sürüm kontrolünü düzene sokmak
4. Kritik hataları ve güvenlik açıklarını gidermek
5. Testleri ve dokümantasyonu tamamlamak
6. Düzenli bakım ve geliştirme planına geçmek

05Kapsam

• OpenAPI şeması
• örnek istekler
• kılavuz

İhtiyaca göre raporlama apı'si, bildirim servisi ve dosya ve medya servisi da aynı yol haritasına eklenebilir.

06Erfelek'te API dokümantasyonu

Erfelek'in PTT verisindeki 254 yerleşim kaydı 2 farklı posta koduna dağılır.

Erfelek'te 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.

Sinop genelinde Dikmen, Gerze ve Saraydüzü gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.

07Ekip ve çalışma biçimimiz

Tasarım, geliştirme, test ve yayın adımları aynı ekip içinde yürür. Kod Git ile sürümlenir, kritik akışlar Playwright testleriyle korunur, yayın Docker konteynerleriyle tekrarlanabilir biçimde yapılır.

• Yayın sonrası bakım ve destek planlanır.
• KVKK baştan tasarlanır.
• Alan adı ve sunucu hesapları işletme adına açılır.

Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz: görüntülü toplantı, ekran paylaşımlı demo ve ortak proje panosu. Donanım kurulumu, depo barkod sistemi kurulumu, saha keşfi veya kullanıcı eğitimi gereken işlerde yerinde çalışma planlanır.

08Örnek hesap

SSSSık sorulan sorular

→İlgili sayfalar

Bu sayfada geçen kavramlar

• OpenAPI şeması
• örnek istekler
• kılavuz
• API anahtarı
• geliştirici portalı
• SSO
• OpenAPI
• SDK
• Swagger
• rate limit
• Sinop
• Erfelek