https://github.com/bigdatacloudapi/js-am-i-roaming-client
A Javascript client for detecting whether a frontend user is currently roaming
https://github.com/bigdatacloudapi/js-am-i-roaming-client
api javascript
Last synced: 3 months ago
JSON representation
A Javascript client for detecting whether a frontend user is currently roaming
- Host: GitHub
- URL: https://github.com/bigdatacloudapi/js-am-i-roaming-client
- Owner: bigdatacloudapi
- License: mit
- Created: 2019-10-09T00:34:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T00:11:16.000Z (over 2 years ago)
- Last Synced: 2025-03-24T19:05:55.687Z (3 months ago)
- Topics: api, javascript
- Language: JavaScript
- Homepage: https://www.bigdatacloud.com
- Size: 2.93 KB
- Stars: 4
- Watchers: 0
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BigDataCloud Free Am-I-Roaming API Client
A Javascript client for detecting whether a frontend user is currently roaming [BigDataCloud](https://www.bigdatacloud.com)
This client works without any Javascript dependencies and has no API key or account requirement... Simply load it up and you're ready check if your frontend users are roaming.
For more information about this API and how it works, [please click here.](https://www.bigdatacloud.com/docs/api/free-am-i-roaming-api)
## Documentation
Documentation specific to this Free API Client is detailed below.
For more information on other available APIs, please visit our [API area](https://www.bigdatacloud.com/docs).
## Authentication / Identification
There is no authentication or identification required to use this API or client.
You may use this API and client for Free without an account.
## Usage Limits
This client-side API is completely FREE for both commercial and non-commercial use, including unlimited usage with no throttling or limitations.
## Manual Installation
1. Download the included javascript file and place it in a publically accessible location
2. Include the script tag `` before your code execution
3. Initiate the Client Info API Client as per the below example
## CDN Installation
1. Include the CDN script tag `` before your code execution
2. Initiate the API Client and make the required calls as necessary
## Example usage
```javascript
getBDCAmIRoaming(
/* provide a callback function for the result */
function(result) {
console.log(result);
}
);
```
## Example output
```javascript
{
"isRoaming": true
}
```