Network Routes Layer API
Reference Guide
Revision 00
NOTICE
This documentation is supplied without representation or warranty of any kind.
Connected2Fiber, Inc. d/b/a Connectbase ("Connectbase") assumes no responsibility
and shall have no liability of any kind arising from supply or use of this publication or
any material contained herein. Any mention of third-party products is for informational
purposes only and constitutes neither an endorsement nor a recommendation.
Connectbase assumes no responsibility with regard to the performance of these
products.
Copyright©2023, Connectbase All Rights Reserved. This document contains
information that is the property of Connectbase. This document may not be copied,
reproduced, or otherwise duplicated, and the information herein may not be used,
disseminated or otherwise disclosed, except with the prior written consent of
Connectbase.
Table of Contents
About This Guide ............................................................................................................. 1
Introduction .............................................................................................................. 1
Accessing the Portal ............................................................................................... 1
Related Documentation .......................................................................................... 1
Acronym List ............................................................................................................. 2
Contact Customer Support .................................................................................... 2
About Network Routes API ............................................................................................. 3
Rate Limit Policy ...................................................................................................... 3
Network Routes Layer API ............................................................................................. 4
GET Network Routes .............................................................................................. 4
Revision History ............................................................................................................... 6
Network Routes Layer API Reference Guide Nov 21, 2023
About This Guide
Introduction
This guide describes the Connectbase Application Program Interface (API) Connected
World Network Routes Layer.
Accessing the Portal
Using any standard web browser, you can access the Connectbase API portal by
entering the following URL: [Link]
• If this is your first time visiting the site, click Sign up to register as a new API user.
• If you are already a registered user, Sign in using your API login and password.
Related Documentation
Refer to the following documents for detailed information about each of the supported
Connectbase API products:
• Address Autocomplete API Reference Guide
• Address Validation API Reference Guide
• Advanced CPQ API Reference Guide
• Building Competitive Rating API Reference Guide
• Connectbase Developer Portal Overview Guide
• Connected World Availability API Reference Guide
• Connected World Account API Reference Guide
• Connected World Building API Reference Guide
• Connected World Building Lists API Reference Guide
• Connected World Contacts API Reference Guide
• Connected World Distributions API Reference Guide
• CPQ Components Management API Reference Guide
• Demand Engine API Reference Guide
• Geocode API Reference Guide
• International Processor API Reference Guide
• Locations Intelligence API Reference Guide
• Network Intelligence API Reference Guide
• Network Path API Reference Guide
• NNI Management API Reference Guide
• Rate Card Management API Reference Guide
• Route Management API Reference Guide
• Tenant API Reference Guide
Network Routes Layer API Reference Guide Nov 21, 2023 1
Acronym List
This document uses the following acronyms:
Acronym Description
API Application Program Interface
CPQ Configure, Price, Quote
HTTP Hyper Text Transfer Protocol
JSON JavaScript Object Notation
N/A Not applicable
URL Uniform Resource Locator
USPS United States Postal Service
Contact Customer Support
If you require technical assistance or wish to report an issue to the Connectbase
Support team, please log into the Connectbase Customer Support portal at https://
[Link] and log a ticket.
For other general information, you can contact Customer Support by email at
support@[Link] or by phone at (508) 202-1807 between the hours of
8:00 a.m. and 5:00 p.m. EST.
Network Routes Layer API Reference Guide Nov 21, 2023 2
About Network Routes API
Network Routes Layer API enables vectortiles format data sharing, include hundreds
of US and International Shareable Networks for integration into clients' web
applications. These vectortiles are securely hosted on dedicated servers, with the
underlying data derived from Connectbase's proprietary Location Truth Shareable
Routes datasets.
*Please contact salesengineering@[Link] to request permission.
Rate Limit Policy
Rate limit is 300 calls per minute.
Currently the API supports visualization zoom level from 0 – 13 in initial release and
cache setting is up to 24 hours. You are required to enable local caching to ensure
rendering performance.
Following is an example of zoom level 13.
Network Routes Layer API Reference Guide Nov 21, 2023 3
Network Routes Layer API
GET Network Routes
Requirements and Special Considerations
All request parameters are required fields.
Request URL
[Link]
Request parameters Characteristic Description/Requirements
x integer X (Tile Column): The x-coordinate, often
referred to as the "tile column," identifies
the horizontal position of the tile within the
grid of tiles at the specified zoom level.
The x-coordinate is usually an integer
value that ranges from 0 (leftmost tile) to
2^z - 1 (rightmost tile) at zoom level z.
y integer Y (Tile Row): The y-coordinate, often
referred to as the "tile row," identifies the
vertical position of the tile within the grid
of tiles at the specified zoom level. The y-
coordinate is also usually an integer value
that ranges from 0 (topmost tile) to 2^z - 1
(bottommost tile) at zoom level z.
z integer Z (Zoom Level): The zoom level, often
denoted as "z," represents the level of
detail or scale at which you want to
view your map. Zoom level 0 typically
represents the entire world as a single tile.
As you zoom in, you increase the zoom
level, which results in more tiles being
used to display the map. Zoom levels are
typically integers.
Request headers Characteristic Description/Requirements
Ocp-Apim- string The subscription key that provides access
Subscription-Key to this API, which can be found in your
Profile.
GET Network Routes request URL
Example [Link]
Success Response Example in Vectortile Format
"4713798"
"2023-05-07 17:17:07"
Network Routes Layer API Reference Guide Nov 21, 2023 4
Success Response Example in Vectortile Format
"BLUE OCEAN"
"4713706"
"2023-01-27 17:48:42"
"CROWN CASTLE"
...
Response Attributes and Data Types
Response Attribute Attribute Description Data Type
"provider_id" Connectbase internal supplier identifier String
"last_modified_date Last modified date of supplier network String
"provider_name" Supplier Name String
Error Response Example
When there’s no vectortile file found, it will return below (not an error):
Error code: 200
{
status: 'success',
message: 'no vectortile find here'
}
Network Routes Layer API Reference Guide Nov 21, 2023 5
Revision History
Revision Date Description
00 September 16, 2023 This is the initial release of this document,
representing v1.
Network Routes Layer API Reference Guide Nov 21, 2023 6