Ghost
Update Ghost integration
Enable or update the Ghost integration for a project. Set enabled, api_url, and admin_api_key to connect BeyondWords to your Ghost site.
PUT
/
projects
/
{project_id}
/
integrations
/
ghost
Update Ghost integration
curl --request PUT \
--url https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"enabled": true,
"admin_api_key": "<string>",
"api_url": "<string>"
}
'import requests
url = "https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost"
payload = {
"enabled": True,
"admin_api_key": "<string>",
"api_url": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, admin_api_key: '<string>', api_url: '<string>'})
};
fetch('https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'admin_api_key' => '<string>',
'api_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost"
payload := strings.NewReader("{\n \"enabled\": true,\n \"admin_api_key\": \"<string>\",\n \"api_url\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"admin_api_key\": \"<string>\",\n \"api_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"admin_api_key\": \"<string>\",\n \"api_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"enabled": false,
"admin_api_key": "4a7ff4d73a1e36b9549449489c7cf85b",
"api_url": "https://localhost.ghost.io",
"created": "2019-12-09 22:18:26 UTC",
"updated": "2020-01-23 08:55:38 UTC"
}Enable or update the Ghost integration for a project. Set
enabled, api_url, and admin_api_key to connect BeyondWords to your Ghost site.
See the Ghost integration guide for setup instructions.Authorizations
Path Parameters
The numeric ID of your project
Response
200 - application/json
successful
Whether or not ghost should be enabled. The default is disabled.
Admin API key for Ghost integration
Ghost API url
Time at which the object was created (ISO 8601)
Time at which the object was updated (ISO 8601)
Was this page helpful?
Previous
Test Ghost integrationTest the Ghost API URL and Admin API key before saving integration settings.
Next
⌘I
Update Ghost integration
curl --request PUT \
--url https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"enabled": true,
"admin_api_key": "<string>",
"api_url": "<string>"
}
'import requests
url = "https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost"
payload = {
"enabled": True,
"admin_api_key": "<string>",
"api_url": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: true, admin_api_key: '<string>', api_url: '<string>'})
};
fetch('https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'admin_api_key' => '<string>',
'api_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost"
payload := strings.NewReader("{\n \"enabled\": true,\n \"admin_api_key\": \"<string>\",\n \"api_url\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"admin_api_key\": \"<string>\",\n \"api_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beyondwords.io/v1/projects/{project_id}/integrations/ghost")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"admin_api_key\": \"<string>\",\n \"api_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"enabled": false,
"admin_api_key": "4a7ff4d73a1e36b9549449489c7cf85b",
"api_url": "https://localhost.ghost.io",
"created": "2019-12-09 22:18:26 UTC",
"updated": "2020-01-23 08:55:38 UTC"
}