Gürsu'da 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.

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.

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.

02Belirtiler

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

Bu projeler çoğu zaman raporlama apı'si, bildirim servisi ve dosya ve medya servisi gibi işlerle birlikte ele alınır.

06Gürsu'da API dokümantasyonu

Gürsu, Bursa iline bağlı bir ilçedir ve PTT adres verisine göre 17 mahalleden oluşur. Bu kayıtlardan 2 tanesi organize sanayi veya serbest bölge kaydıdı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.

Gürsu'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.

Bursa genelinde Harmancık, Osmangazi ve Mustafakemalpaşa gibi diğer ilçelerdeki işletmelerle de aynı uzaktan çalışma düzeniyle ilerlenir.

07Nasıl çalışıyoruz?

Projeler tasarım, yazılım geliştirme, test ve yayın adımlarını kapsayan bir ekiple yürütülür. Sürüm kontrolü (Git), otomatik testler (Playwright), konteyner tabanlı yayın (Docker), sürekli entegrasyon ve izleme araçları standart çalışma düzenimizin parçasıdır.

• Alan adı ve sunucu hesapları işletme adına açılır.
• Kapsam ve teslim kriterleri yazılı olur.
• Kaynak kod ve veri işletmeye teslim edilir.

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
• SDK
• rate limit
• OpenAPI
• Bursa
• Gürsu