Karayazı'da API dokümantasyonu

01Hangi durumlarda gerekir?

Olaylar anlık bildirilmesi gerektiğinde

Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.

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.

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ı
• Küçük bir değişikliğin başka yerleri bozması

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

API dokümantasyonu ile birlikte sık planlanan işler arasında raporlama apı'si, bildirim servisi ve dosya ve medya servisi bulunur.

06Karayazı'da API dokümantasyonu

Karayazı'nın PTT verisindeki 75 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; Karayazı'daki 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.

Aynı ildeki Tortum, Aziziye ve Pasinler ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.

07Nasıl çalışıyoruz?

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.
• Her değişiklik önce test ortamında denenir.

Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışıyoruz; Erzurum da bunlardan biri.

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
• SDK
• OpenAPI
• rate limit
• OAuth 2.0
• Erzurum
• Karayazı