People and systems can work on the same data
Users can work through the interface while integrations interact with the underlying platform through the API.
WEEZIE API
Everything you can do in Weezie, available through the API.
Weezie is built to be used both through its interface and programmatically. Actions available to users in the Weezie UI can also be performed through the API, giving your team the flexibility to integrate network data and operational workflows directly into your own systems.
Example API request
GET /api/v1/assets
Authorization: Bearer {token}
Accept: application/jsonUSE THE API YOUR WAY
Use Weezie as a platform, not just an application.
The API exposes the same underlying platform capabilities used by the Weezie interface. This makes it possible to connect Weezie to internal applications, automate repetitive operations, synchronize data, or build entirely different experiences on top of the platform.
Network data
Read and manage the network information your workflows depend on, including the assets and relationships represented in Weezie.
Planning and design
Integrate network planning and design operations into external tools and automated workflows.
Field operations
Connect field workflows with the wider systems used by your organization.
Tasks and workflows
Use the API to connect Weezie operations to your existing business processes.
Inventory and connectivity
Work programmatically with the network inventory and its relationships.
Files and supporting information
Keep operational information associated with the corresponding network or workflow records.
Reporting and data access
Use Weezie data outside the application when another system needs to consume, transform, or present it.
Custom applications
Build experiences around Weezie without having to reproduce the underlying network platform.
ONE PLATFORM, MULTIPLE WAYS TO WORK
Use the interface, the API, or both.
Your teams do not have to choose between manual workflows and integrations. Operations can be performed through the Weezie interface when direct interaction makes sense, while the same platform can be accessed programmatically when automation or system-to-system communication is a better fit.
Build around your existing architecture
Use the API to connect Weezie with the systems already involved in your network operations.
Automate where it makes sense
Processes that would otherwise require interaction with the interface can be incorporated into automated workflows.
Create specialized experiences
Use the platform capabilities behind Weezie to support applications and interfaces designed for a particular team, customer, or process.
REQUESTS AND RESPONSES
Work with Weezie programmatically.
API operations follow the same domain concepts represented throughout Weezie, making it easier to move between interactive and programmatic workflows.
Code examples for Weezie API
Example request
GET /api/v1/assets
Authorization: Bearer {token}
Accept: application/jsonExample response
GET /api/v1/network/assets/{id}
Accept: application/json
Authorization: Bearer {token}Example response body
{
"id": "...",
"type": "...",
"properties": {
"...": "..."
}
}*Examples shown on this page are illustrative. Available resources, fields, and operations depend on the corresponding Weezie capabilities and API documentation.*
INTEGRATION CONSIDERATIONS
Everything needed to design a reliable integration.
Implementation design checklist
From design assumptions to operating reliability.
Use this checklist as the opening pass before implementation planning.
Authentication and access
How applications authenticate and which Weezie resources they are allowed to access.
Data model
How Weezie network, inventory, planning, and operational concepts map to your own systems.
Errors and validation
How integrations should handle invalid requests, validation results, and unsuccessful operations.
Pagination and querying
How applications can work efficiently with collections and larger datasets where applicable.
Versioning
How integrations can account for changes to API resources and behavior over time.
Repeatable operations
How automated processes can safely coordinate actions between systems.
Events and automation
Where appropriate, integration designs can combine API operations with events or external automation.
Usage patterns
We can review expected API usage as part of the integration design.
Development and testing
Integration approaches can be validated before being introduced into production workflows.
Lifecycle and change management
Integration dependencies can be considered as Weezie and the connected systems evolve.
Documentation
Relevant endpoints, resources, parameters, and integration behavior can be documented for the implementation.
BUILT AROUND YOUR WORKFLOW
Start with what you want to connect.
An integration does not need to begin with an endpoint list. Start with the workflow, the systems involved, and the outcome you want to achieve. From there, we can identify how the Weezie API fits into the architecture.
OSS and BSS integrations
Create stable order and services workflows while preserving billing and asset mappings.
GIS and geospatial systems
Exchange layout, geometry, and context with your spatial operating layer.
ERP and inventory platforms
Coordinate materials, assets, and network capacity with operational planning records.
Network planning tools
Bring planning decisions into the same system-of-record, with clear acceptance and handover flow.
Field applications
Feed field findings and exception handling into the same integration boundary.
Reporting and analytics
Prepare network and operational insights for internal or external analysis systems.
Data synchronization
Synchronize records where systems have different freshness or ownership expectations.
Workflow automation
Move repetitive operational actions into durable, testable workflows.
Internal applications
Build differentiated operations tools for distinct teams using one shared network backbone.
Customer or partner portals
Expose selected capabilities and status updates without losing control of core identifiers.
BUILD A WORKING INTEGRATION
Connect Weezie to the rest of your operation.
Whether you need to automate an existing Weezie workflow, synchronize network data with another platform, or build a custom application, the API gives you a programmatic way to work with the same capabilities available through Weezie.