Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

ghost-client

2.0.0 • Public • Published

ghost-client

This module connects to your Ghost blog and gives you a list of what you need, posts, tags or users.

Ghost API is currently in Beta, you have to configure your blog to access the API and you have to get a token or a ID and a Secret Code to get what you want.

See Ghost API Documentation

[![NPM](https://nodei.co/npm/ghost-client.png)](https://nodei.co/npm/ghost-client/)

Table of Concepts

Installation

To download the Ghost API Client that I've made simply download it via NPM. NPM is always going to have the latest stable version of it. Be free to add any flag after the command such as --save or --save-dev

 
$ npm install ghost-client
 

Authentication: Client Authentication

To use the Client Authentication method described on the API Docs of Ghost you have to give the instance of the Ghost API Client a clientId and a clientSecret. See Ghost Docs to find how to obtain it

 
var ghost = require('ghost-client')
var Client = ghost.createClient({
  endpoint: 'http://my-ghost-blog.com',
  clientId: 'ghost-frontend',
  clientSecret: 'rabbitsareawesome'
})
 

Authentication: User Authentication

To use the User Authentication method described on the API Docs of Ghost you have to give the instance of the Ghost API Client a Bearer Token. See Ghost Docs to find how to obtain it

 
var ghost = require('ghost-client')
var Client = ghost.createClient({
  endpoint: 'http://my-ghost-blog.com',
  token: 'Bearer 0X0X0X0X0X0X0X0X0X0X0X'
})
 

Available resources and methods

Client means the variable that has the client to connect to the Ghost API correctly configured. See authentication again to see more about that variable.

Client.posts()

Brings posts list from a Ghost Blog.

 
Client.posts({}, function (err, posts) {
  if (err) console.log(err)
  console.log(posts)
})
 

Client.tags()

Brings tags list from a Ghost Blog.

 
Client.tags({}, function (err, tags) {
  if(err) console.log(err)
  console.log(tags)
})
 

Client.users()

Brings users list from a Ghost Blog.

 
Client.users({}, function (err, users) {
  if(err) console.log(err)
  console.log(users)
})
 

Adding parameters to available resources and methods

If you want to add a parameter when you run a function, for example you want to use the limit parameter to limit the resources that you want to get, simply write them into the array before the callback.

Check the Ghost API Docs to learn more about parameters

 
// Example using the 'limit' parameter to get posts
Client.posts({ limit: 4 }, function (err, posts) {
    if(err) console.log(err)
    console.log(posts)
})
 

License MIT

Copyright (c) 2015 - Miguel Ruiz

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.

install

npm i ghost-client

Downloadsweekly downloads

39

version

2.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability