Cloud-RF API
Use this JSON API to build and test radio links for any radio, anywhere. Authenticate with your API2.0 key in the request header as key
Communication#openapi#telecom#location
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Use this JSON API to build and test radio links for any radio, anywhere. Authenticate with your API2.0 key in the request header as key
Endpoints 11
Manage
- GETDelete a calculation from the database.
/archive/delete?cid=0Warning! you could lose data. This function will delete the entry from the database and the file from the disk. Accidental deletion can be reversed by… - GETDelete an entire network
/archive/delete/network?nid=stringWarning! you could lose data. This function will delete the entry from the database and the file from the disk. Accidental deletion can be reversed by… - GETExport a calculation in a GIS file format
/archive/export?file=string&fmt=kmlDownload your data in a format suitable for a third party viewer like Google Earth or ESRI Arcmap. - GETList calculations from your archive
/archive/list?n=0.0&e=0.0&s=0.0&w=0.0List your area and path calculations, sorted by time and limited to the last few hundred. To fetch all for a given network append a 'net' filter with the… - POSTUpload clutter data as GeoJSON
/clutter/addUpload GeoJSON lineString and polygon features to your account. The height property is in metres and the material code / type / attenuation are.. 1 Trees –…
Create
- POSTCreate a point-to-multipoint heatmap
/areaAn area coverage assumes the same receiver height at all locations out to fixed radius (maximum 300km). Due to it's exhaustive processing it is the slowest of… - POSTPoint-to-point path profile analysis (Tx to Rx)
/pathA path profile is a single link from A to B. It is much faster than an area calculation and can be used out to 300km. A basic request needs transmitter,… - POSTPoint-to-multipoint path profile analysis (Many Tx, one Rx)
/pointsThe points function tests many transmitters and one receiver and is designed for route analysis. A minimal request needs a transmitters array of…
Analyse
- GETFind the best server for overlapping coverage
/interference?network=string&name=stringMerge and analyse sites within a network channel to determine the best server at a given location. Each site will be dynamically allocated a monochrome colour… - GETMerge sites into a super layer.
/mesh?network=string&name=stringA merge of 'area' calculations for a network to create a single super layer. Stronger signals are promoted over weaker ones. The same colour key must be used. - GETFind the best server for somewhere
/network?net=string&nam=string&lat=0.0&lon=0.0&alt=0&rxg=0.0Query your network to find the best server(s) for a given receiver/customer location. A previously generated network is required.
API details
- Base URL
https://api.cloudrf.com- Authentication
- An API key in the key header
- Operations
- 11 operations on 11 pathsGET 7POST 4
- Main resources
- Manage 5Analyse 3Create 3
- Description format
- OpenAPI 3.0.1, API version
2.0.0 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Cloud-RF API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud-RF API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Delete a calculation from the database.” (GET /archive/delete?cid=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud-RF API?
Use this JSON API to build and test radio links for any radio, anywhere. Authenticate with your API2.0 key in the request header as key It is listed under Communication and has 11 endpoints.
Who publishes the Cloud-RF API?
It is listed from CloudRF's public API description (an OpenAPI document), not published by CloudRF on Swastik Codes. Anyone who controls cloudrf.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud-RF API?
Requests go to https://api.cloudrf.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud-RF API?
With an API key in the key header.
How many endpoints does the Cloud-RF API have?
11 operations on 11 paths (7 GET, 4 POST). The largest groups are Manage, Analyse, Create.
Is forking the Cloud-RF API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.