Contents:
Methods of embedding CycleStreets in other sites
We offer a cloud-based service to embed our routing in your site.
This is a supported service which attracts a fee (except for small, non-profit organisations). Please see details of the service.
In all cases, the hosting and running of the site is done by CycleStreets, not the organisation, as setup would be time-consuming and mean the system goes out of date due to ongoing developments.
White label sites (2022 onwards)
Our newer offering, being introduced in 2022, uses a simple and more industry-standard method of embedding.
To embed the site, we will provide you with a snippet of HTML which will load the relevant files from our system. These are loaded into the page via Javascript.
The embed code is CMS-agnostic, so as long as you can paste in HTML into your system (which is the norm), it will work.
The system will automatically adapt to the width and height of your content.
You will probably wish to set a small number of options relating to the look and feel, e.g. rounded corners or aspects of the colour scheme. These will be set as options in the embed code or via our control panel.
Existing customers can upgrade for free to this newer offering.
White label sites (pre-2022)
Our older product has a range of ways for embedding:
Method 1 (Recommended): |
Subdomain of your site (or a dedicated domain)If your organisation's website address is www.placeford.org This is the simplest and most flexible way. Steps:
|
Method 2 (Recommended): |
Subdirectory of your siteIf your organisation's website address is www.placeford.org This best from a URL perspective but requires you to run a proxy (which is slightly more technically demanding than Method 1). This method uses HTTP Proxying to fetch the pages from our servers, even though it appears on your site. If using Apache you will need access to httpd.conf rather than just .htaccess . Steps:
|
Method 3 (Avoid if possible) |
iframe methodWe can set up a site which can be loaded in an iFrame. This is reasonably simple at both ends, but has the downside of being unable to have a unique URL for each journey that people can e-mail to others. This involves the webteam simply creating an iFrame in the relevant part of your site, with the target being a URL that we will set up and confirm. Steps:
|
Method 4 (Advanced) |
API calls into your own interfaceThis is by far the most advanced option and requires programming and much testing from your webteam, and so is not really recommended unless you are prepared to put in ongoing resources. We have an API which provides a journey solution when provided with the details (start and end points etc.) of a requested journey. This data would need to be captured and then inserted into an interface which you run. This requires an ongoing commitment to resourcing at your end so that the system keeps pace with any changes to the API we implement. Steps:
|