API documentation

Note that this documentation is being trialled for use with the Street Manager Beta and is aimed towards authorised Beta participants. As Street Manager remains under active development, this documentation will continue to develop over time.


Overview

This page contains guidance for developers integrating their systems with the Street Manager API so they can submit and retrieve information about street works.


API Integration Guide

This guide details best practices and common patterns for integrating with Street Manager


Specification Documentation

Version 5 - Stable

This is the V5 baseline specification. There are no breaking changes planned to be introduced in upcoming releases; while new functionality may be introduced in future versions of the V5 specification, these changes will be purely additive in nature to prevent existing integrations from breaking.

Version 6 - Stable

This is the V6 baseline specification. There are no breaking changes planned to be introduced in upcoming releases; while new functionality may be introduced in future versions of the V6 specification, these changes will be purely additive in nature to prevent existing integrations from breaking.

See the Key differences between V5 and V6 for more information.


Releases

Current

Upcoming