ghost-api v1.0.0

ghost-api

Table of Contents

• Installation
• Authentication: Client Authentication
• Authentication: User Authentication
• Public API - POSTS - TAGS - USERS
• Private API
• License MIT

Installation

$ npm install ghost-api

Authentication: Client Authentication

const ghost = require('ghost-api');

const options = {
 endpoint: 'http://YOUR-GHOST-SITE-DOMAIN.com',
 clientId: 'CLIENT-ID',
 clientSecret: 'CLIENT-SECRET'
};

let client = ghost.createClient(options);

Authentication: User Authentication

const ghost = require('ghost-api');

const options = {
 endpoint: 'http://YOUR-GHOST-SITE-DOMAIN.com',
 token: 'YOUR-ACCESS-TOKEN-HERE'
};

let client = ghost.createClient(options);

Public API

POSTS

client.getPosts

client.getPosts({}, function (err, response, posts) {
	if(err){
        console.log(err);
    } else {
        console.log(posts);
    }
});

client.getPostById

client.getPostById({}, 'post-id-here', function (err, response, post) {
    if(err){
        console.log(err);
    } else {
        console.log(post);
    }
});

client.getPostBySlug

client.getPostBySlug({},'post-slug-here', function (err, response, post) {
    if(err){
        console.log(err);
    } else {
        console.log(post);
    }
});

TAGS

client.getTags

client.getTags({}, function (err, response, tags) {
	if(err){
        console.log(err);
    } else {
        console.log(tags);
    }
});

client.getTagById

client.getTagById({}, 'tag-id-here', function (err, response, tag) {
    if(err){
        console.log(err);
    } else {
        console.log(tag);
    }
});

client.getTagBySlug

client.getTagBySlug({},'tag-slug-here', function (err, response, tag) {
    if(err){
        console.log(err);
    } else {
        console.log(tag);
    }
});

USERS

client.getUsers

client.getUsers({}, function (err, response, users) {
	if(err){
        console.log(err);
    } else {
        console.log(users);
    }
});

client.getUserById

client.getUserById({}, 'user-id-here', function (err, response, user) {
    if(err){
        console.log(err);
    } else {
        console.log(user);
    }
});

client.getUserBySlug

client.getUserBySlug({},'user-slug-here', function (err, response, user) {
    if(err){
        console.log(err);
    } else {
        console.log(user);
    }
});

Private API

Coming soon!

License MIT

Copyright (c) 2018 - Arda Yigithan Orhan

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.