OpenAPI/Swagger ve geliştirici kılavuzu hazırlama.
01Hangi durumlarda gerekir?
Olaylar anlık bildirilmesi gerektiğinde
Webhook altyapısı imza doğrulama ve yeniden deneme ile kurulur.
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.
02Belirtiler
- Küçük bir değişikliğin başka yerleri bozması
- Dokümantasyon ve kurulum bilgisinin olmaması
- Kütüphane ve çatı sürümlerinin desteğinin bitmesi
- Kodu yazan kişiye veya firmaya ulaşılamaması
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 |
04Hangi sistemlerde uygulanır?
- Yazılım şirketleri
- Veri sağlayıcıları
- Platform kuran girişimler
- Kurumsal BT ekipleri
- İş ortağı ekosistemi olan firmalar
05İş nasıl ilerler?
- Kod, erişimler ve ortamlar üzerinde durum tespiti yapmak
- Riskleri ve öncelikleri listelemek
- Test ortamı ve sürüm kontrolünü düzene sokmak
- Kritik hataları ve güvenlik açıklarını gidermek
- Testleri ve dokümantasyonu tamamlamak
- Düzenli bakım ve geliştirme planına geçmek
NotEski API sürümleri için kullanım dışı bırakma takvimi duyurulur.
06Kapsam
- 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.
07Dörtyol'da API dokümantasyonu
Dörtyol'un PTT verisindeki 15 yerleşim kaydı 1 farklı posta koduna dağılır. Birden fazla ilçede ekibi veya şubesi olan işletmelerde API dokümantasyonu için kullanıcı rolleri, şube bazlı görünürlük ve merkezi raporlar birlikte planlanır.
Yazılım projelerinde analiz, tasarım ve geliştirme çoğunlukla uzaktan, görüntülü toplantılarla yürür; Dörtyol'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 Hassa, Samandağ ve Kırıkhan ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
Dörtyol bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
08Nası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.
- Ölçülebilir hedefler konur: arama ve WhatsApp tıklaması, form talebi, işlem süresi.
- KVKK baştan tasarlanır.
- Kapsam ve teslim kriterleri yazılı olur.
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.
SSSSık sorulan sorular
Dörtyol'da bulunuyorum, yerinde görüşme mümkün mü?
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.
API'yi kimlerin kullandığını nasıl izleriz?
Her istemciye ayrı anahtar veya OAuth istemcisi verilir; kullanım, hata ve kota tüketimi istemci bazında raporlanır.
Ne kadar sürer?
Süre işin kapsamına ve erişimlerin hazır olmasına göre değişir; ön değerlendirmeden sonra planlı bir takvim paylaşılır.
Sadece Hatay için mi çalışıyorsunuz?
Hayır, Türkiye'nin her ilindeki işletmelerle çalışıyoruz; Akdeniz Bölgesi dahil tüm bölgelerde süreç aynı düzenle yürür.
İş sırasında site 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.
Uzaktan yapılabilir mi?
Çoğu teknik iş uzaktan, verilen erişimlerle yapılır; donanım veya yerinde kurulum gereken işler ayrıca planlanı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.
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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Dörtyol'da ilgili hizmetler
Hatay içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- SDK
- rate limit
- OAuth 2.0
- Hatay
- Dörtyol