v1 entegrasyon API’si

Erişim anahtarıyla proje verisini okuyun, değişiklikleri izleyin ve sürüm kontrollü yazın.

Son güncelleme: 2026-11-10

Bu sayfada

Başlangıç Uçlar Sayfalama ve değişiklik akışı Yazma ve hata yönetimi Şema ve uygulama belgesi

Başlangıç

Dış entegrasyon uçları /api/v1 altındadır. Authorization: Bearer başlığında erişim anahtarı gerekir; oturum çerezi bu uçlarda kimlik doğrulamaz. Anahtarın kapsamı, sahibinin güncel kurum ve proje yetkileriyle birlikte uygulanır.

Kullanıcı oturumuyla bir erişim anahtarı oluşturun ve sırrı güvenli alana alın.
GET /api/v1/me ile kullanılan kimliği ve anahtar kapsamını kontrol edin.
GET /api/v1/projects ile erişilebilir projeleri alın.
Dönen proje kimliğiyle nesneleri sayfalayarak okuyun.
Yazma gerekiyorsa oku ve yaz kapsamını, proje rolünü, bölge ve modül izinlerini kontrol edin.

GET /api/v1/projects
Authorization: Bearer ERISIM_ANAHTARI

ERISIM_ANAHTARI yer tutucusunu oluşturma yanıtındaki sgk_ ile başlayan sırla değiştirin. Anahtarı URL’ye, uygulama kaynak koduna veya günlüklere koymayın.

Uçlar

Yöntem ve uç	Yanıt ve kullanım
`GET /api/v1/me`	`user` ve kullanılan anahtarın güvenli üst verisi
`GET /api/v1/projects`	Erişilebilir ana projelerin dizisi; tasarım dalları listelenmez
`GET /api/v1/projects/{pid}`	Proje bilgisi ve görünür nesne sayıları
`GET /api/v1/projects/{pid}/features`	GeoJSON `FeatureCollection`, `next` ve `cursor`
`GET /api/v1/projects/{pid}/features/{fid}`	Tek GeoJSON nesnesi
`GET /api/v1/projects/{pid}/equipment`	Fiber cihazları; `items` ve `next`
`GET /api/v1/projects/{pid}/connections`	Fiber bağlantıları; `items` ve `next`
`GET /api/v1/projects/{pid}/circuits`	Teknik devreler; `items` ve `next`
`GET /api/v1/projects/{pid}/changes`	Ham değişiklik kayıtları; `items` ve `next`
`POST /api/v1/projects/{pid}/edit`	Genel düzenleme sözleşmesiyle atomik yazma

features için type ve WGS 84 sırasıyla bbox=minBoylam,minEnlem,maxBoylam,maxEnlem filtreleri kullanılabilir. equipment ve connections uçlarında node_id düğüm filtresidir. Katalog okuma ve dosya aktarımı gibi çerezli uygulama uçlarının tümü v1’e taşınmış değildir; uç adlarını yukarıdaki sözleşmeden veya şemadan alın.

Sayfalama ve değişiklik akışı

Sayfalı uçlarda limit varsayılanı 1000, aralığı 1–5000’dir. after, son sayfanın döndürdüğü kimliktir. Yanıttaki next değerini sonraki isteğin after alanına verin; next: null son sayfayı belirtir. Proje listesi bu sayfalı zarfı kullanmaz.

Nesne yanıtındaki cursor, nesne sorgusundan önce okunan proje değişiklik kimliğidir. İlk okumanın bu değerini saklayarak GET /api/v1/projects/{pid}/changes?after={cursor} ile aradaki değişiklikleri izleyebilirsiniz. Akışın imleci sayısaldır; nesne kimlikleri metindir. Satırları artan kimlik sırasıyla işleyin ve başarıyla uygulanan son değişiklik kimliğini saklayın.

Kapalı modülün değişiklik satırı, önceki ve sonraki veri yerine gizli: true taşıyabilir. Anahtar veya kullanıcı kapsamı değişince yerel görünümü yeniden oluşturun. Webhook bir değişiklik bildirimi sağlar; ayrıntılı veriyi API’den okuyun.

Yazma ve hata yönetimi

POST /api/v1/projects/{pid}/edit, Düzenleme API’si sayfasındaki ops, sürüm ve geçici kimlik kurallarını kullanır. v1’de request_id zorunludur. Aynı kullanıcı ve projede aynı işlem kimliğiyle aynı içerik yeniden gönderildiğinde ilk sonuç döner; farklı içerik 409 ile reddedilir. Güncelleme ve silmede güncel kayıt sürümünü gönderin.

v1 hata zarfı her zaman detail, kod, alan alanlarını içerir; detail doğrulama hatasında dizi olabilir. Yanıt başlıkları X-GIS-API-Surum: 1, X-GIS-Surum ve Cache-Control: no-store içerir. X-GIS-Surum, uygulama sürümüdür. 429 yanıtındaki Retry-After bekleme süresini saniye cinsinden bildirir; v1 ve OGC aynı anahtar sayacını paylaşır.

Şema ve uygulama belgesi

GET /api/v1/openapi.json yalnız v1 sözleşmesini, GET /api/v1/docs uygulamayla birlikte sunulan kullanım belgesini döndürür. Bu iki uç kimlik gerektirmez. Sitenin API referansı, uygulamadan üretilen daha geniş şemayı gösterir. Şemaya giren kurulum yönetimi yolları uygulamanın çalışma moduna bağlıdır; şemada bulunmak bütün yolların erişim anahtarıyla çağrılabildiği anlamına gelmez.