weather_bell_api_for_vizrt

weather_api_for_vizrt

WeatherApiForVizrt - JavaScript client for weather_api_for_vizrt This is a sample Weather API to provide Weather Data to a Vizrt Graphics System This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 weather_api_for_vizrt --save

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

Finally, switch to the directory you want to use your weather_api_for_vizrt from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('weather_api_for_vizrt') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/weather_api_for_vizrt then install it via:

    npm install YOUR_USERNAME/weather_api_for_vizrt --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, that's to say your javascript file where you actually use this library):

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 WeatherApiForVizrt = require('weather_api_for_vizrt');

var defaultClient = WeatherApiForVizrt.ApiClient.instance;

// Configure API key authorization: APIKeyHeader
var APIKeyHeader = defaultClient.authentications['APIKeyHeader'];
APIKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKeyHeader.apiKeyPrefix['X-API-Key'] = "Token"

var api = new WeatherApiForVizrt.DefaultApi()

var lat = 3.4; // {Number} Latitude

var lng = 3.4; // {Number} Longitude

var opts = { 
  'unitTemp': "c", // {String} Units (f, c, or k)
  'unitWind': "knot", // {String} Units (kph, mph, or knot)
  'unitRain': "cm", // {String} Units (cm or in)
  'unitSnow': "cm", // {String} Units (cm or in)
  'unitPressure': "hPa" // {String} Units (inHg, hPa, Pa, mb)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.currentByLatLngGet(lat, lng, , opts, callback);

Documentation for API Endpoints

All URIs are relative to https://weatherbell.com/viz-api/v1

Class	Method	HTTP request	Description
WeatherApiForVizrt.DefaultApi	currentByLatLngGet	GET /current/byLatLng	Returns current weather data by latitude & longitude
WeatherApiForVizrt.DefaultApi	currentByLocationIdGet	GET /current/byLocationId	Returns current weather data by Location ID
WeatherApiForVizrt.DefaultApi	forecastByLatLngGet	GET /forecast/byLatLng	Returns forecast data by latitude & longitude
WeatherApiForVizrt.DefaultApi	forecastByLocationIdGet	GET /forecast/byLocationId	Returns forecast data by Location ID
WeatherApiForVizrt.DefaultApi	historicalByLatLngGet	GET /historical/byLatLng	Returns historical Weather data by latitude, longitude & timestamp
WeatherApiForVizrt.DefaultApi	historicalByLocationIdGet	GET /historical/byLocationId	Returns historical Weather data by Location ID & date
WeatherApiForVizrt.DefaultApi	observationByLatLngGet	GET /observation/byLatLng	Returns observation data by latitude & longitude
WeatherApiForVizrt.DefaultApi	observationByLocationIdGet	GET /observation/byLocationId	Returns observation data by Location ID

Documentation for Models

• WeatherApiForVizrt.Change
• WeatherApiForVizrt.Conditions
• WeatherApiForVizrt.Cumulative
• WeatherApiForVizrt.CumulativePressure
• WeatherApiForVizrt.CumulativeRain
• WeatherApiForVizrt.CumulativeSnow
• WeatherApiForVizrt.CumulativeTemperature
• WeatherApiForVizrt.Humidity
• WeatherApiForVizrt.Ice
• WeatherApiForVizrt.Location
• WeatherApiForVizrt.PointData
• WeatherApiForVizrt.Pressure
• WeatherApiForVizrt.Rain
• WeatherApiForVizrt.Series
• WeatherApiForVizrt.SeriesData
• WeatherApiForVizrt.Snow
• WeatherApiForVizrt.Stats
• WeatherApiForVizrt.SunMoon
• WeatherApiForVizrt.Temperature
• WeatherApiForVizrt.Total
• WeatherApiForVizrt.UnitPressure
• WeatherApiForVizrt.UnitRain
• WeatherApiForVizrt.UnitSnow
• WeatherApiForVizrt.UnitTemp
• WeatherApiForVizrt.Wind

Documentation for Authorization

APIKeyHeader

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header