Integrate with Connectbase APIs
About Connectbase APIs
Connectbase has developed a series of API products that enable you to access, update, and share data. Using our APIs, you can extract data from The Connected World platform to integrate directly into your system of choice, enabling you to disseminate valuable data into other internal systems.
To sign up, or to access the Connectbase APIs, go to https://developer.connectbase.com
At a high-level, the Connectbase API stack includes:
Location Engagement APIs - A set of APIs that enable sellers to communicate out serviceability, availability, and pricing, as well as enable buyers to easily consume that information.
Location Intelligence APIs - A set of APIs that enables users to query location-based network availability and vendor data, as well as tenant data.
Location Management APIs - A set of APIs that enables a Connectbase provider to access and update their own data, including account/user information, building information, contacts, and distributions.
Location Cleansing APIs - A set of APIs that allows for verification, validation, and cleansing of domestic and international addresses.
Product Management APIs - A set of APIs that allows for the management of CPQ components, rate cards, and API translations.
API Product | Product Description | APIs |
|---|---|---|
Address Processor | The Address Processor product provides a set of APIs used for address validation and formatting of U.S addresses. |
|
Advanced CPQ | The Advanced CPQ product provides a set of APIs that enable users with advanced methods to create deals, configure pricing requirements, return quotes for locations, and create orders. | The Advanced CPQ APIs enable users to create accounts, deals, configure pricing requirements, and return quotes for locations. V3 offers bulk quoting capability to process up to 3000 locations in a single transaction. |
Connected World Availability Engine, v5 | The Connected World Availability Engine product provides a set of APIs that enable a provider to share information with their partner(s) about their buildings and the products and services they offer at those buildings. | The Connected World Availability APIs enable a provider to share information with their partner(s) about their buildings and the products and services they offer at those buildings. |
Connected World Building - Silver | The Connected World Building – Silver product provides a set of APIs that enable developers to access their own building resources. |
|
Connected World Intelligence | The Connected World Intelligence product provides a set of APIs that enable users to query location-based network availability, vendor, and tenant data for a specific company or building id. |
|
CPQ | The Configure, Price, Quote product provides a set of APIs provides a set of APIs that enable users to create deals, configure pricing requirements, and return quotes for locations. | The CPQ v2 APIs enable you to create accounts, deals, add locations, create quotes, and get quote prices. Note: This is an older version of CPQ APIs and Connectbase recommends upgrading to the Advanced CPQ. |
Demand Engine | The Demand Engine product enables developers to programmatically extract analytics from the Connectbase Demand Engine -- a reporting tool that provides you with insight into the locations your channel and business partners most often search. | The Demand Engine API enables developers to programmatically extract analytics from the Connectbase Demand Engine. |
International Address Processor | The International Address Processor product is used for address validation and formatting of international addresses. | The International Address Processor is used for address validation and formatting of international addresses. It supports up to 254 countries. The verification and geocoding levels differ by available precision of data for each country. Geocoding may be rendered as Delivery Point, Premise, Thoroughfare, Locality, or None. |
Location Intelligence | The Location Intelligence API is used to collect census data. | The Census Info API enables you to retrieve census block information using latitude and longitude search. Census block data includes such information as population density and median household income, for example. |
Market Data Layer | Market data Layer is used to enable vectortiles format data sharing. | Network Routes Layer API enables vectortiles format data sharing, including hundreds of US and International Shareable Networks for integration into clients' web applications. These vectortiles are securely hosted on the our dedicated server, with the underlying data derived from Connectbase's proprietary Location Truth Shareable Routes datasets. |
Network Intelligence | The Network Intelligence product provides a set of APIs that enable users to get network information that is based on a specific address, such as broadband, cableco, NearNet, OnNet, telco, and wisp. | The Network Intelligence v6 API enables you to retrieve network information based on a specific address, such as broadband, cableco, conformed providers, building providers, nearnet, onnet, telco, and wisp. |
Network Path | The Network Path product provides a set of APIs that enable users to perform a path search between two locations, inclusive of all paths or a specific company path, and receive a Segment ID, calculated distance, and latency in the response. Additionally, a secondary endpoint enables users to compare two different segment ids to determine if they are diverse from one other. | The Network Path API enables clients to submit an A and Z location that returns a geojson-formatted response for those two endpoints, inclusive of all paths or a specific company path. It will assign a Segment ID, calculate distance and latency, and present that information in the response in addition to the geojson data. There is also a secondary endpoint which allows for two different segment ids to be compared and determines if they are diverse from one other. |
Product Management | The Product Management product provides a set of APIs that allow for the management of components, rate cards, and API product translations. |
|
Route Management | The Route Management API enables you to retrieve route data from the Connected World platform. You can use the API to find the nearest routes within the defined request parameters. | The Shareable Routes API enables customers to retrieve route information from The Connected World platform’s US Shareable Routes and International Shareable Routes data points. The response provides the fiber routes within a radius given as a value (siteDistance) as well as the provider of those routes. |
API | Description |
|---|---|
Address Autocomplete API v2 | Enables developers to search the database using a partial address. The resulting return is a list of parsed, autocompleted USPS addresses that match the search criteria provided. |
Address Validation API v4 | Used to validate a complete USPS address inclusive of a secondary address line (IE Apt, Ste, FL) and to obtain more detailed information about the address location, such as the latitude and longitude, Timezone, UTC Offset, Census Block, Building Location Type, and Global Id. It will also determine the validity and requirement of a secondary address line. |
Address Validation API v5 | Validates an address and returns the components in an easy to use JSON response. Use commas to separate address elements for best results. Version 5 includes Timezone, UTC offset, and Census Block. |
Advanced CPQ v2 | Enables users to create accounts, deals, configure pricing requirements, and return quotes for locations. |
Advanced CPQ v3 | his Advanced CPQ API v3 includes several back-end optimisations that deliver an improved bulk quoting experience (Enhanced bulk quoting limit from 500 locations to 3000 locations in a single transaction). |
Building Competitive Rating API | Enables user to retrieve the competitive rating for a given location. Competitive ratings data helps you to better understand the competitive landscape and more effectively price services. |
Connected World Availability API | Enables a provider to share information with their partner(s) about their buildings and the products and services they offer at those buildings. |
Connected World Availability API v3 | |
Connected World Availability API v5 | |
Connected World Building API v4 | Enables users to create, retrieve, update, or remove buildings or building attributes. |
Connected World Building API v5 | |
ConnectedWorld Account API | Enables you to retrieve your company’s Connectbase account information. |
ConnectedWorld Building API v2 | Enables a provider to share information with their partner(s) about their buildings and the products and services they offer at those buildings. |
ConnectedWorld Building Lists API | Enable you to retrieve building list data from your instance. |
ConnectedWorld Contacts API | Enables you to add, retrieve, or update contact information in your instance. |
ConnectedWorld Distributions API | Enables you to create, get, initiate, or update a distribution report. |
CPQ API v2 | Enables you to create accounts, deals, add locations, create quotes, and get quote prices. Note: This is an older version of CPQ APIs and Connectbase recommends upgrading to the Advanced CPQ. |
CPQ Components | Enables you to set up “reusable” pricing groups for use in a CPQ quote under the configured conditions. |
Demand Engine | Enables developers to programmatically extract analytics from the Connectbase Demand Engine. |
Geocode API – v1 | Enables developers to pass a location in a request body to return the latitude and longitude of the given location. The response indicates an accuracy rating and accuracy type. Accuracy scores range from a confidence level of 0-1 where the higher value indicates more accurate results. Accuracy type values include the following: country, state, county, city, district, street, intersection, house number. |
International Address Validation API | Used for address validation and formatting of international addresses. It supports up to 254 countries. The verification and geocoding levels differ by available precision of data for each country. The Geocoding may be rendered as Delivery Point, Premise, Thoroughfare, Locality, or None. |
Location Intelligence API – v1 | Enables you to retrieve census block information using latitude and longitude search. Census block data includes such information as population density and median household income, for example. |
Network Intelligence API v6 | Enables you to retrieve network information based on a specific address, such as broadband, cableco, conformed providers, building providers, nearnet, onnet, telco, and wisp. |
Network Path API | Enables you to submit an A and Z location that returns a geojson-formatted response for those two endpoints, inclusive of all paths or a specific company path. It will assign a Segment ID, calculate distance and latency, and present that information in the response in addition to the geojson data. There is also a secondary endpoint which allows for two different segment ids to be compared and determines if they are diverse from one other. |
Network Routes Layer API | Network Routes Layer API enables vectortiles format data sharing, including hundreds of US and International Shareable Networks for integration into clients' web applications. These vectortiles are securely hosted on the our dedicated server, with the underlying data derived from Connectbase's proprietary Location Truth Shareable Routes datasets. |
NNI Management API | Enables you to create geography rules and create and manage your NNI locations. |
Rate Card API | Enables you to create and manage your company and supplier rate cards. |
Shareable Routes | Enables you to retrieve route information from The Connected World platform’s US Shareable Routes and International Shareable Routes data points. The response provides the fiber routes within a radius given as a value (siteDistance) as well as the provider of those routes. |
Tenant API v2 | Enables you to retrieve a tenant listing for a specific company and building ID, returned in a JSON array. |