Genel bakış

Uygulamanın mimarisini ve entegrasyon API’sinin mevcut sınırlarını tanıyın.

Son güncelleme: 2026-11-10

Mimari

SoSoMaps, tarayıcı arayüzü ve Python tabanlı FastAPI sunucusundan oluşan tek uygulamadır. Kalıcı veri PostgreSQL üzerinde tutulur; geometriler ve mekânsal işlemler PostGIS kullanır. Tarayıcı HTTP üzerinden JSON istekleriyle sunucuya bağlanır. Dosya yüklemeleri multipart/form-data, indirmeler ilgili dosyanın içerik türüyle çalışır.

Her proje bir kuruma bağlıdır. Proje API’si, oturumdaki kullanıcının kurumunu ve rolünü denetler. Kurum sınırı, istemcinin gönderdiği bir kurum başlığıyla değiştirilemez. Harita geometrileri WGS 84 koordinatlarında saklanır; öznitelikler ve bazı teknik kayıtlar JSON alanları taşır.

API’nin bugünkü durumu

Tarayıcı uygulaması oturum çerezli /api uçlarını kullanır. Dış entegrasyon için v1 API, /api/v1 altında erişim anahtarıyla çalışır. X-GIS-API-Surum: 1 API sürümünü, X-GIS-Surum uygulama sürümünü bildirir. /api/v1/openapi.json ve /api/v1/docs herkese açık şema ve kullanım belgesidir; varsayılan Swagger ve ReDoc uçları açık değildir.

Bu belgeler uygulamanın kullandığı mevcut HTTP sözleşmesini açıklar. Çerezli API’de bütün hata yanıtları tek biçimde değildir; v1 hataları detail, kod, alan zarfını kullanır. Kullanılabilir katalog, oturum ve proje kapsamı sunucudan okunmalıdır.

İlk okuma akışı

1. Kimlik doğrulama sayfasıyla uygun kapsamlı erişim anahtarını hazırlayın.
2. GET /api/v1/me ile anahtarın bağlı olduğu kullanıcıyı ve kapsamını okuyun.
3. GET /api/v1/projects ile erişilebilir projeleri listeleyin.
4. GET /api/v1/projects/{pid}/features ile görünür harita verisini alın; sayfalama ve değişiklik imlecini saklayın.
5. İlk API isteği öğreticisiyle okuma, yazma ve değişiklik takibini tamamlayın.

{pid}, sunucunun döndürdüğü sayısal proje kimliğidir. Çerezli uygulama uçlarıyla çalışırken Düzenleme API’si ve İçe aktarım API’si sayfalarındaki kimlik akışını ayrıca izleyin.

İstemci üretimi ve indirmeler

SoSoMaps için yayımlanmış resmi SDK yoktur. v1 OpenAPI dosyasını indirerek kendi istemcinizi üretebilir veya Postman koleksiyonunu içe aktarabilirsiniz.

OpenAPI Generator kullanım belgesi ve Python üretici belgesi temel alınarak, araç kurulmuş bir ortamda şu komut kullanılabilir:

openapi-generator-cli generate -i sosomaps-v1.openapi.json -g python -o sosomaps-istemci

Bu komut yerel istemci dosyaları üretir. Temel adresi ve Authorization: Bearer başlığını kendi yapılandırmanızda tanımlayın; şemada genel nesne olarak bırakılan yanıtları v1 referansındaki alan açıklamalarıyla değerlendirin. Üretilen istemciyi hedef kurulumda doğrulayın; bu sayfadaki örnek bir SDK kabul testi değildir.

Modül ve ürün sınırı

Çekirdek ile ortak saha her zaman açıktır. Adres ve bina ile fiber modülleri kurum, proje ve lisans kapsamına göre kullanılabilir. Elektrik altyapısı varsayılan kapalıdır ve henüz genel kullanıma açık değildir. Katalogda elektrikle ilgili tanımlar bulunması genel kullanım hakkı anlamına gelmez.

Ürün; harita, fiziksel altyapı, fiber bağlantıları, bina ve uç kapasitesi, teknik devre ve mühendislik çıktıları içindir. CRM, faturalama, NOC/alarm, genel ticket ve SCADA işlevleri kapsam dışıdır. customer teknik anahtarı adres girişini ifade eder; ticari müşteri kaydı değildir.

Arayüz Türkçedir. Çevrimdışı saha paketleri, ofis incelemesi, tasarım onayı ve kontrollü yayın ürün kapsamındadır. Proje olayları için webhook, dış harita ve nesne okuma için OGC yayını kullanılabilir.