skikrumb-api v1.2.1

skiKrumb Tracker Software - © skiKrumb Trackers Inc.

A wrapper for the skiKrumb API to use in Node.js and Client applications

Install skiKrumb API

$ npm i skikrumb-api
$ yarn add skikrumb-api

Example

import skiKrumb from 'skikrumb-api';

const {readDeviceData} = skiKrumb({
    apiKey: 'YOUR_API_KEY',
    requestedWith: 'My Application Name',
    url: 'Defaults to http://api.skikrumb.ca'
})

skiKrumb(options?)

options

Type: object

apiKey

Type: string

Your API Key as provided by skiKrumb.

requestedWith

Type: string\ Default: 'skiKrumb API Wrapper'

Sets the requestedWith header. Helps with identifying your application.

url

Type: string\ Default: 'https://api.skikrumb.ca'

Defaults to production skiKrumb API URL. Possible values: https://api-dev.skikrumb.ca or localhost testing.

API Documentation

Swagger Documentation

Requires an API key. Request an API Key by emailing info@skikrumb.ca

© skiKrumb 2023