openapi_iplocation

OpenapiIplocation - JavaScript client for openapi_iplocation OpenAPI v3 specification and a set of generated API clients for iplocation.net This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.1.0
Package version: 1.1.0
Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/oapicf/openapi-iplocation

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install openapi_iplocation --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your openapi_iplocation from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/oapicf/openapi-iplocation then install it via:

    npm install oapicf/openapi-iplocation --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var OpenapiIplocation = require('openapi_iplocation');


var api = new OpenapiIplocation.DefaultApi()
var ip = "ip_example"; // {String} An IPv4 or IPv6 address that you would like to lookup.
var opts = {
  'format': "format_example", // {String} Output format, the following formats are supported: plain xml json jsonp php csv serialized
  'delimiter': "delimiter_example" // {String} Delimiter between proxies. Can be used only with format plain. The following types are supported: 1 for \"\\n\", 2 for \"<br>\".
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rootGet(ip, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.iplocation.net

Class	Method	HTTP request	Description
OpenapiIplocation.DefaultApi	rootGet	GET /	Get geolocation of an IP address

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.