siteleaf-sdk

### Node.js SDK

An unofficial API wrapper library for interacting with the Siteleaf.

let siteleaf = new Siteleaf({
  apiKey: 'xxx',
  apiSecret: 'xxx'
})
 
siteleaf.get('sites', (error, sites) => {
  console.log(sites) // My sites!
})

Requirements

• Node.js >= 4.x

Installation

npm install siteleaf-sdk

Getting Started

You will need an API key and secret token to get started. You can find this in your Siteleaf account dashboard.

// Require the library
let Siteleaf = require('siteleaf')
 
// Create a new instance using your api key and secret
let siteleaf = new Siteleaf({
  apiKey: process.env.SITELEAF_API_KEY,
  apiSecret: process.env.SITELEAF_API_SECRET,
})

For a full list of configuration options see: Configuration

Making requests

You are now ready to make API requests. To do so, use one of the convenience methods from your instance:

siteleaf.delete()
siteleaf.get()
siteleaf.post()
siteleaf.put()

Simply pass the path, optional parameters and a callback function.

 
// List all users
siteleaf.get('users', (error, response) => {
  console.log(error, response)
})
 
// Create a new site
let site = {title: 'My new site', domain: 'example.com'}
siteleaf.post('sites', site, (error, response) => {
  console.log(error, response)
})
 

For a full list of all available API methods see: https://github.com/siteleaf/siteleaf-api

Configuration

Config	Environment Variable	Description	Default
apiKey	SITELEAF_API_KEY	API Key	null
apiSecret	SITELEAF_API_SECRET	API Secret	null
endpoint	SITELEAF_API_ENDPOINT	API Endpoint	https://api.siteleaf.com
version	SITELEAF_API_VERSION	API Version	v1
methods		Available rest methods	['delete', 'get', 'post', 'put']

Development

Commands

Name	Command	Description
Lint	npm run lint	Runs the Standard code linter over the codebase
Pretest	npm pretest	An alias for lint
Test	npm test	Runs the test suite

License

node-siteleaf-sdk: Copyright (c) 2015 Desmond Morris

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.