Geliştirici belgeleri

İlk API isteği, kimlik doğrulama, veri sözleşmeleri, harita yayını ve kurulum.

Temeller

Genel bakışUygulamanın mimarisini ve entegrasyon API’sinin mevcut sınırlarını tanıyın.İlk API isteğinizErişim anahtarı oluşturun; proje verisini okuyun, izinli bir noktayı yazın ve değişiklikleri izleyin.API sürümü ve değişikliklerAPI sözleşmesini uygulama sürümünden ayırın ve değişiklik kayıtlarını izleyin.API sözleşme kurallarıTemel adres, başlık, kimlik, koordinat, sayfalama ve tekrar güvenliği kurallarını birlikte okuyun.API alan adları sözlüğüKimlik, sayfalama, düzenleme ve hata alanlarının türünü ve anlamını öğrenin.Kimlik doğrulama ve kapsamEntegrasyon anahtarının kapsamını belirleyin; dış API ile uygulama oturumunu ayırın.v1 entegrasyon API’siErişim anahtarıyla proje verisini okuyun, değişiklikleri izleyin ve sürüm kontrollü yazın.Erişim anahtarlarıEntegrasyon anahtarlarını okuma, yazma ve proje kapsamıyla oluşturun ve iptal edin.Webhook bildirimleriProje olaylarını alın, ham gövde imzasını doğrulayın ve tekrar teslimleri yönetin.OGC veri ve harita yayınıProje nesnelerini OGC API Features ile okuyun ve WMS harita katmanlarını kullanın.Hata kodları ve istemci kararlarıHTTP durumunu, makine kodunu ve alan bilgisini birlikte değerlendirin; güvenli yeniden denemeyi doğru seçin.Hata yanıtlarını okumaHata zarfı ve istemci kararları için güncel hata kodları sözlüğüne geçin.Eşzamanlılık ve tekrar güvenliğiSürüm kontrolünü, işlem kimliğini ve toplu değişiklikleri doğru yönetin.

Veri

Veri modeliTemel varlıkları, proje sınırını ve kimliklerin anlamını öğrenin.Düzenleme API’siNesne, cihaz ve bağlantıları toplu düzenleme isteğiyle oluşturun ve değiştirin.Nesne türleri ve alanlarKatalogdaki harita ve cihaz türlerini doğrulama kurallarıyla birlikte kullanın.

Aktarım ve çıktı

İçe aktarım API’siGeometri ve birim tablolarını yükleme, önizleme ve onay adımlarıyla aktarın.Dışa aktarım API’siProje geometrilerini biçim, tür ve harita kapsamına göre dosyaya çıkarın.Proje paketiProje paketinin biçimini, kapsamını ve boş projeye geri yükleme kurallarını öğrenin.Çıktılar API’siSaha raporlarını ve birlikte üretilen çıktı paketlerini HTTP üzerinden alın.

Kurulum

Kurulum ve işletim bileşenleriUygulamanın bağımlılıklarını, ortam ayarlarını ve yönetim komutlarını hazırlayın.Lisanslama ve saat davranışıKurum içi kurulumun lisans dosyası akışını, durumlarını ve API yazma izinlerine etkisini öğrenin.

Referans

API referansıSürümlü v1 API, OGC harita yayını ve uygulama gruplarına ayrılmış uç sözleşmeleri.

API referansı

Sürümlü API v1 referansıSürümlü API v1 uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.OGC harita yayını referansıOGC harita yayını uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Aktarım kaynakları referansıAktarım kaynakları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Bağlantı izleme referansıBağlantı izleme uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Bina adayları referansıBina adayları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Birim adayları referansıBirim adayları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Birim aktarımı referansıBirim aktarımı uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Birim kararları referansıBirim kararları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Birim ve uç kayıtları referansıBirim ve uç kayıtları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Cihazlar referansıCihazlar uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Düzenleme referansıDüzenleme uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Düğümler referansıDüğümler uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Dışa aktarma referansıDışa aktarma uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Elektrik (Yakında) referansıElektrik (Yakında) uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Erişim anahtarları referansıErişim anahtarları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Etiketler referansıEtiketler uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Geçmiş referansıGeçmiş uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Güzergâh referansıGüzergâh uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Kablolar referansıKablolar uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Kesinti etkisi referansıKesinti etkisi uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Kullanıcılar referansıKullanıcılar uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Kurumlar referansıKurumlar uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Kıl tahsisi referansıKıl tahsisi uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Metraj referansıMetraj uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Nesneler referansıNesneler uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.OTDR konumlama referansıOTDR konumlama uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Optik hesaplar referansıOptik hesaplar uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Optik ölçümler referansıOptik ölçümler uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Oturum referansıOturum uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Proje paketi referansıProje paketi uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Proje politikası referansıProje politikası uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Proje özeti referansıProje özeti uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Projeler referansıProjeler uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Referans katmanları referansıReferans katmanları uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Saha ekleri referansıSaha ekleri uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Sağlık referansıSağlık uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Teknik devreler referansıTeknik devreler uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Topoloji denetimi referansıTopoloji denetimi uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Webhook yönetimi referansıWebhook yönetimi uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Çıktılar referansıÇıktılar uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.Üst veri referansıÜst veri uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.İçe aktarma referansıİçe aktarma uçlarının kimlik, parametre, istek ve yanıt sözleşmeleri.