Skip to content

padlocks/SimplyAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SimplyAPI

An API wrapper for SimplyPlural, written in Node.js.

Installation

Node.js 16.9.0 or newer is required.

npm install simplyapi
yarn add simplyapi

Usage and examples

This project has examples of how to use this package under the examples folder. Proper documentation will be created at a later date.

Environment Variables

These can be set either in the .env file, in terminal, or in the config vars section of Heroku.

Setting Default Description
url https://v2.apparyllis.com The base URL for all SimplyPlural API requests. Unless you are running your own fork of Simply Plural, you shouldn't change this.
api_version v1 The target SimplyPlural API version. Unless you are running your own fork of Simply Plural, you shouldn't change this.
token token_here Your SimplyPlural account token. Full permissions are necessary to use some features.
userId user_id Your SimplyPlural account/system ID. You can find it in account info near the bottom.

Links

About

An API wrapper for SimplyPlural, written in node.

Resources

License

Stars

Watchers

Forks

Packages

No packages published