OpenAPI/Swagger ve geliştirici kılavuzu hazırlama.
01Hangi durumlarda gerekir?
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.
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
- Kodu yazan kişiye veya firmaya ulaşılamaması
- Hataların tekrar tekrar ortaya çıkması
- Kütüphane ve çatı sürümlerinin desteğinin bitmesi
- 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?
- 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
NotWebhook teslim hataları ve yeniden denemeler raporlanır.
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.
06Onikişubat'ta API dokümantasyonu
Onikişubat, Kahramanmaraş iline bağlı bir ilçedir ve PTT adres verisine göre 142 mahalleden oluşur. Bu kayıtlardan 1 tanesi organize sanayi veya serbest bölge kaydıdı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.
Onikişubat'ta PTT verisine göre 1 OSB/SB kaydı bulunur; üretim ve tedarik zinciriyle çalışan işletmelerde API dokümantasyonu için B2B süreçler ve mevcut programlarla entegrasyon ayrıca konuşulur. Mesafe yazılım işinin önünde engel değildir: Onikişubat'taki ekiplerle görüntülü görüşme, ekran paylaşımı ve test ortamı bağlantısıyla çalışılır; cihaz kurulumu veya saha keşfi gerekirse yerinde ziyaret planlanır.
Aynı ildeki Afşin, Türkoğlu ve Pazarcık ilçeleri için de API dokümantasyonu talepleri değerlendirilir; toplantılar uzaktan yapılır.
Onikişubat bölgesinden API dokümantasyonu talebiniz için 0540 003 19 81 numarasını arayabilir veya teklif formunu doldurabilirsiniz.
07Ekip ve çalışma biçimimiz
Çalışma düzenimizde sürüm kontrolü, otomatik testler, konteyner tabanlı yayın ve izleme araçları standarttır; her değişiklik bu adımlardan geçerek canlıya çıkar.
- Kaynak kod ve veri işletmeye teslim edilir.
- Her değişiklik önce test ortamında denenir.
- Ölçülebilir hedefler konur: arama ve WhatsApp tıklaması, form talebi, işlem süresi.
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
Örnek: otomasyonla kazanılan süre
- Günlük tekrarlanan iş
- 82
- İş başına süre
- 7 dk
- Aylık süre (22 iş günü)
- 210,5 saat
- Otomasyon sonrası doğrulama payı (%13)
- 27,4 saat
Not: örnek hesaptır; kesin plan analizde çıkar.
SSSSık sorulan sorular
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.
Onikişubat'ta yüz yüze görüşebilir miyiz?
İşin büyük bölümü uzaktan yürür: ilk görüşme telefonla, sonraki toplantılar görüntülü yapılır. Kurulum ya da eğitim gerekiyorsa yerinde çalışma takvime eklenir.
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.
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.
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.
Kahramanmaraş dışındaki işletmelere de hizmet veriyor musunuz?
Evet. Askadar Yazılım, Türkiye'nin 81 ilindeki işletmelerle uzaktan çalışır; gerektiğinde yerinde çalışma ayrıca planlanı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.
→İlgili sayfalar
API Dokümantasyonu hakkında diğer konular
Onikişubat'ta ilgili hizmetler
Kahramanmaraş içindeki diğer ilçeler
Bu sayfada geçen kavramlar
- OpenAPI şeması
- örnek istekler
- kılavuz
- API anahtarı
- geliştirici portalı
- SSO
- OAuth 2.0
- rate limit
- Swagger
- Kahramanmaraş
- Onikişubat