Skip to content

Commit

Permalink
fix: links
Browse files Browse the repository at this point in the history
Updated old broken links.
  • Loading branch information
bigdatacloud-api committed Jan 9, 2023
1 parent 1c256eb commit 8902dcb
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# BigDataCloud NodeJS API Client


A NodeJS client for connecting to the API services provided by [BigDataCloud](https://www.bigdatacloud.net)
A NodeJS client for connecting to the API services provided by [BigDataCloud](https://www.bigdatacloud.com)


## What API services does [BigDataCloud](https://www.bigdatacloud.net) offer?
## What API services does [BigDataCloud](https://www.bigdatacloud.com) offer?

BigDataCloud offers a range of extremely useful and fast APIs that can be utilised in both backend and frontend scenarios.
From validating customer input live to the next generation of IP Geolocation technology, BigDataCloud has an API suitable to your needs.

For a full list of APIs, visit our [documentation area](https://www.bigdatacloud.net/ip-geolocation-apis).
For a full list of APIs, visit our [documentation area](https://www.bigdatacloud.com/docs).

You can access any and all BigDataCloud APIs with a free API Key.
To get your API Key, just access your account and retrieve it from your [Account Dashboard](https://www.bigdatacloud.net/customer/account).
To get your API Key, just access your account and retrieve it from your [Account Dashboard](https://www.bigdatacloud.com/account).
If you are not yet a customer, it is completely free to join.



## Documentation

For documentation specific to this api client, please read below.
For more specific documentation to the APIs available, including endpoints, request and response data, please visit our [documentation area](https://www.bigdatacloud.net/ip-geolocation-apis).
For more specific documentation to the APIs available, including endpoints, request and response data, please visit our [documentation area](https://www.bigdatacloud.com/docs/ip-geolocation).


## Update Notes
Expand All @@ -34,7 +34,7 @@ For more specific documentation to the APIs available, including endpoints, requ
## Authentication / Identification

To use this API client you must have a BigDataCloud API Key.
To get your personal key, just access your account and retrieve it from your [Account Dashboard](https://www.bigdatacloud.net/customer/account).
To get your personal key, just access your account and retrieve it from your [Account Dashboard](https://www.bigdatacloud.com/account).
If you are not yet a customer, it is completely free to join.

Simply provide this key when initiating the api client, and it will be included in all requests to the BigDataCloud API Server.
Expand All @@ -50,10 +50,10 @@ See the example below.

## Example usage

The below example is found in the included demo.js.
The below example is found in the included demo.js. It demonstrates the use of our IP geolocation API from [IP Geolocation API Package](https://www.bigdatacloud.com/packages/ip-geolocation).

```javascript
const client = require('@bigdatacloudapi/client')('XXX'); // XXX being your api key found at: https://www.bigdatacloud.net/customer/account
const client = require('@bigdatacloudapi/client')('XXX'); // XXX being your api key found at: https://www.bigdatacloud.com/account

/*
* All api endpoints can be accessed via magic methods in the following camelised format:
Expand Down Expand Up @@ -243,4 +243,4 @@ Wrap any synchronous calls in a try/catch handler, and ensure to include the .ca
}
})();

```
```

0 comments on commit 8902dcb

Please sign in to comment.