The code examples within this repository have been published to help people integrate custom apps with the powerful CloudRF API.
In order to use these examples you require an account on the CloudRF service (or a private server) with a valid API key. This can be obtained from https://cloudrf.com/my-account.
Below are the list of available examples which can be used. You are encouraged to read the respective README.md for each which will detail additional information and usage.
- The python directory contains a parent Python 3 script which allows interaction with all of the primary CloudRF API endpoints. This script is quite comprehensive and so for usage you are recommended to consult the README for more information.
- The bash directory contains some Bash scripts which make use of cURL to to CloudRF API.
- The slippy-maps directory contains examples of various web map libraries which interface with the CloudRF API.
- You can play with live examples at https://cloud-rf.github.io/CloudRF-API-clients/slippy-maps/index.html
- The templates directory contains example JSON templates which can be used to streamline planning with the API.
- The model-gallery directory contains a demonstration of 3D models.
- You can explore some 3D models at https://cloud-rf.github.io/CloudRF-API-clients/model-gallery/index.html
You are free to use the public API in commercial apps with attribution to CloudRF. If you need an exemption get in touch or buy your own server.
An example of acceptable use would be a online map with an option to add RF coverage as an extra layer.
If you are building an application or a business which is critically dependent upon our API, you should contact us first to let us know and establish a service level agreement.
A random example of unacceptable use would be a used car salesman with a business MBA launching a new RF planning tool, without prior communication, which just wraps our API for a markup.
Full terms and conditions are available at https://cloudrf.com/terms-and-conditions
You will be responsible for your account and how it is used so be good as we can be savage with miscreants.
Below are a list of resources which may aid you with writing your own clients to integrate with the CloudRF API.
- CloudRF Website: https://cloudrf.com/
- OpenAPI Reference: https://cloudrf.com/documentation/developer/
- Postman API docs: https://docs.cloudrf.com/
- User Interface: https://cloudrf.com/ui/
- User Documentation: https://cloudrf.com/documentation
- Video Tutorials: https://youtube.com/cloudrfdotcom
Paste your API key into these demos and click away.