Script integration with the Ghost Admin API to support working with sites hosting using the Ghost open source CMS platform. This object offers convenience over direct HTTP requests by:

  • Integrating with Drafts Credentials system to store your API key.
  • Handling request JWT authorization headers for requests
  • Parsing results to JSON

Example

Creating a Post

// construct a post object to send to Ghost API
let post = {
"title": "Post title",
"html": "My HTML content",
"status": "draft",
}
// wrap it in an array, per docs
let data = {
"posts": [
post
]
}

// make request to API
let g = new Ghost()
let response = g.request({
"path": "/admin/posts/",
"method": "POST",
"parameters": {"source": "html"},
"data": data
})
if (response.success) { // successful
// get the URL of the post from the response data
let url = response.responseData["posts"][0]["url"]
if (url) {
console.log(`Ghost Post Created: ${url}`)
}
console.log(response.responseText)
}
else {
console.log(`Ghost Post Failed: ${response.statusCode}
${response.responseText}
`)
context.fail()
}

Hierarchy

  • Ghost

Constructors

Methods

Constructors

  • Create new instance.

    Parameters

    • Optional identifier: string

    Returns Ghost

Methods

  • Execute a request against the Ghost Admin API. For successful requests, the HTTPResponse object will contain an object or array or objects decoded from the JSON returned by your Ghost installation as appropriate to the request made. Refer to Ghost Admin API documentation for details about the expected parameters and responses.

    Parameters

    • settings: {
          data?: {
              [x: string]: string;
          };
          headers?: {
              [x: string]: string;
          };
          method: string;
          parameters?: {
              [x: string]: string;
          };
          path: string;
      }
      • Optional data?: {
            [x: string]: string;
        }

        An object containing data to be encoded into the HTTP body of the request. Drafts will take care of the JSON conversion.

        • [x: string]: string
      • Optional headers?: {
            [x: string]: string;
        }

        An object contain key-values to be added as custom headers in the request. There is no need to provide authorization headers, Drafts will add those.

        • [x: string]: string
      • method: string

        The HTTP method, like "GET", "POST", etc.

      • Optional parameters?: {
            [x: string]: string;
        }

        An object containing key-values to be added to the request as URL parameters. Drafts will take care of encoding these.

        • [x: string]: string
      • path: string

        The path to the API endpoint in the OpenAI API. This should include the path after the API version. For example /chat/completion

    Returns HTTPResponse

  • Creates a new Ghost object.

    Parameters

    • Optional identifier: string

      Credential identifier used to distinguish between multiple Ghost sites. Only needed if multiple sites are being targeted.

    Returns OpenAI

Generated using TypeDoc