Skip to content
TR
EN
Product
Features
Screenshots
Plans
Security
User guide
Developer
Plans and pricing
Support
Contact
Plans and pricing
Developer documentation
Your first API request, authentication, data contracts, map publishing and deployment.
Search documentation
First request
Quick start
Authentication
Contract conventions
Reading and monitoring data
Versioned API
Error codes
Versioning
Event notifications and map publishing
Webhook
OGC publishing
API reference
Fundamentals
Overview
Understand the application architecture and the current integration API contract.
Your first API request
Create an access key, read project data, write an authorised point and track changes.
API versioning and changes
Distinguish the API contract from the application version and follow documentation changes.
API contract rules
Read the rules for base URLs, headers, authentication, coordinates, pagination and safe retries.
API field glossary
Understand the types and meanings of identity, pagination, editing and error fields.
Authentication and scope
Set the integration key scope and distinguish the external API from application sessions.
v1 integration API
Read project data with an access key, track changes and write with version control.
Access keys
Create and revoke integration keys with read, write and project scopes.
Webhook notifications
Receive project events, verify raw-body signatures and handle repeat deliveries.
OGC data and map services
Read project features through OGC API Features and use WMS map layers.
Error codes and client decisions
Interpret HTTP status, machine codes and field details together, and choose safe retry behaviour.
Reading error responses
Use the current error-code glossary for error envelopes and client decisions.
Concurrency and safe retries
Manage record versions, operation identifiers and batch changes correctly.
Data
Data model
Learn the main entities, project boundaries and identifier meanings.
Editing API
Create and update features, equipment and connections with a batch edit request.
Feature types and fields
Use catalogue map and equipment types with their validation rules.
Import and export
Import API
Import geometries and unit tables through upload, preview and confirmation steps.
Export API
Export project geometries by format, feature type and map extent.
Project bundle
Understand the bundle format, its contents and the rules for restoring into an empty project.
Outputs API
Retrieve field reports and combined output packages over HTTP.
Installation
Installation and operations
Prepare application dependencies, environment settings and administration commands.
Licensing and clock behaviour
Understand on-premises licence files, licence states and their effect on API write permissions.
Reference
API reference
Endpoint contracts grouped into the versioned v1 API, OGC map services and application APIs.
API reference
Versioned API v1 reference
Versioned API v1 endpoint authentication, parameters, request and response contracts.
OGC map services reference
OGC map services endpoint authentication, parameters, request and response contracts.
Import sources reference
Import sources endpoint authentication, parameters, request and response contracts.
Connection tracing reference
Connection tracing endpoint authentication, parameters, request and response contracts.
Building candidates reference
Building candidates endpoint authentication, parameters, request and response contracts.
Unit candidates reference
Unit candidates endpoint authentication, parameters, request and response contracts.
Unit import reference
Unit import endpoint authentication, parameters, request and response contracts.
Unit decisions reference
Unit decisions endpoint authentication, parameters, request and response contracts.
Unit and endpoint records reference
Unit and endpoint records endpoint authentication, parameters, request and response contracts.
Equipment reference
Equipment endpoint authentication, parameters, request and response contracts.
Editing reference
Editing endpoint authentication, parameters, request and response contracts.
Nodes reference
Nodes endpoint authentication, parameters, request and response contracts.
Export reference
Export endpoint authentication, parameters, request and response contracts.
Electric (Coming soon) reference
Electric (Coming soon) endpoint authentication, parameters, request and response contracts.
Access keys reference
Access keys endpoint authentication, parameters, request and response contracts.
Labels reference
Labels endpoint authentication, parameters, request and response contracts.
History reference
History endpoint authentication, parameters, request and response contracts.
Route reference
Route endpoint authentication, parameters, request and response contracts.
Cables reference
Cables endpoint authentication, parameters, request and response contracts.
Outage impact reference
Outage impact endpoint authentication, parameters, request and response contracts.
Users reference
Users endpoint authentication, parameters, request and response contracts.
Organisations reference
Organisations endpoint authentication, parameters, request and response contracts.
Fiber strand assignment reference
Fiber strand assignment endpoint authentication, parameters, request and response contracts.
Bill of quantities (BoQ) reference
Bill of quantities (BoQ) endpoint authentication, parameters, request and response contracts.
Features reference
Features endpoint authentication, parameters, request and response contracts.
OTDR location reference
OTDR location endpoint authentication, parameters, request and response contracts.
Optical calculations reference
Optical calculations endpoint authentication, parameters, request and response contracts.
Optical measurements reference
Optical measurements endpoint authentication, parameters, request and response contracts.
Session reference
Session endpoint authentication, parameters, request and response contracts.
Project bundle reference
Project bundle endpoint authentication, parameters, request and response contracts.
Project policy reference
Project policy endpoint authentication, parameters, request and response contracts.
Project summary reference
Project summary endpoint authentication, parameters, request and response contracts.
Projects reference
Projects endpoint authentication, parameters, request and response contracts.
Reference layers reference
Reference layers endpoint authentication, parameters, request and response contracts.
Field attachments reference
Field attachments endpoint authentication, parameters, request and response contracts.
Health reference
Health endpoint authentication, parameters, request and response contracts.
Technical circuits reference
Technical circuits endpoint authentication, parameters, request and response contracts.
Topology checks reference
Topology checks endpoint authentication, parameters, request and response contracts.
Webhook management reference
Webhook management endpoint authentication, parameters, request and response contracts.
Outputs reference
Outputs endpoint authentication, parameters, request and response contracts.
Metadata reference
Metadata endpoint authentication, parameters, request and response contracts.
Import reference
Import endpoint authentication, parameters, request and response contracts.
×
