Integrations & API

WordPress

The rankboost WordPress plugin registers a small private REST API on your site. rankboo.st calls those endpoints to connect, verify, and publish — nothing else touches your WordPress install.

Requirements

Install the plugin

Connect to rankboo.st

The connection handshake is plugin-initiated. When you click Connect in the WordPress admin, the plugin sends your site URL and a one-time token to /connect/wordpress on rankboo.st. The platform then:

How publishing works

When an article is scheduled to publish, rankboo.st sends a POST request to /wp-json/rankboost/v1/publish with the article payload. The plugin calls wp_insert_post() internally — this means:

• Posts appear as normal WordPress posts (not custom post types).
• Yoast SEO and Rank Math focus keyword meta are set automatically from the article keyword.
• Featured images are fetched from the rankboo.st CDN and set via the WordPress media library.
• If the article was already published, a re-publish updates the existing post (post_id is included in the payload).

The publish payload looks like this:

POST /wp-json/rankboost/v1/publish
Authorization: Bearer rb_site_...

{
  "title":     "Your article title",
  "content":   "<p>Full HTML body…</p>",
  "slug":      "your-article-slug",
  "keyword":   "target seo keyword",
  "image_url": "https://cdn.rankboo.st/…/image.jpg",

  // Only present on updates:
  "post_id": 42
}

A successful response returns the live post URL and WordPress post ID:

{ "link": "https://yoursite.com/your-article-slug/", "id": 42 }

Plugin endpoints

Disconnecting

Go to Dashboard → Integrations → WordPress → Disconnect. rankboo.st will call POST /wp-json/rankboost/v1/disconnect as a best-effort request, then remove the stored token. If your site is unreachable at the time, the local disconnect still completes. You can reconnect at any time.

Shopify

rankboo.st connects to Shopify via standard OAuth 2.0. Once connected, articles are published to whichever Online Store blog you choose using the Shopify GraphQL Admin API (2026-01).

Requirements

Install the app

OAuth flow

The OAuth handshake follows the standard Shopify OAuth 2.0 pattern. Here is what happens under the hood:

Select a blog

After OAuth completes, rankboo.st lists all blogs from your Shopify store (blogs(first: 50) GraphQL query) so you can choose where articles should appear. You can change the target blog at any time from Dashboard → Integrations → Shopify.

How publishing works

Articles are published via the Shopify GraphQL Admin API. On first publish, rankboo.st calls articleCreate. If the article is updated and re-published, it calls articleUpdate using the stored article GID.

The fields sent to Shopify:

The live article URL is returned by Shopify as https://<shop>/blogs/<blog-handle>/<article-handle> and stored on the dashboard post.

Disconnecting

Go to Dashboard → Integrations → Shopify → Disconnect. The stored access token is removed. If you uninstall the rankboost app from the Shopify admin directly, Shopify sends an app/uninstalled webhook which automatically disconnects the integration on rankboo.st too.

Content API

If you are not on WordPress or Shopify — or if you want to pull content into your own frontend regardless of where it is also published — the Content API lets you fetch published articles over HTTPS using simple HTTP Bearer authentication.

Overview

Authentication

Every request must include an Authorization header with your API key as a Bearer token (rbk_…).

Authorization: Bearer rbk_abc123xyz789…

# Example with curl:
curl https://rankboo.st/api/content/v1/site \
  -H "Authorization: Bearer rbk_abc123xyz789…"

Endpoints

{
  "site": {
    "name":         "Tyrrell Analytics",
    "url":          "https://tyrrell.example.com",
    "languageCode": "en"
  }
}

GET /api/content/v1/posts?limit=10
GET /api/content/v1/posts?limit=10&cursor=abc123def456

{
  "posts": [ /* array of post objects — see Response shapes */ ],
  "nextCursor": "abc123def456"   // null when no more pages
}

GET /api/content/v1/posts/my-seo-article-slug
GET /api/content/v1/posts/8f3a2c1d-…

{
  "post": { /* post object */ }
}

Response shapes

Every post object returned by the API has the following fields:

{
  "id":          "8f3a2c1d-4b5e-…",        // Public UUID — stable identifier
  "title":       "Your article title",
  "slug":        "your-article-slug",       // URL-safe slug, may be null
  "excerpt":     "A short summary…",        // May be null
  "html":        "<h2>…</h2><p>…</p>",      // Full rendered HTML body
  "image": {
    "url":       "https://cdn.rankboo.st/…",
    "alt":       "Article featured image"
  },                                         // null if no image
  "publishedAt": "2026-06-11T09:00:00.000Z",
  "seo": {
    "metaTitle":       "Custom meta title",  // null if not set
    "metaDescription": "Meta description",  // null if not set
    "keyword":         "target keyword"      // null if not set
  }
}

Pagination

The /posts endpoint uses cursor-based pagination. The cursor is the id (public UUID) of the last post in the current page.

// Page 1
const page1 = await fetch("/api/content/v1/posts?limit=10", { ... });
const { posts, nextCursor } = await page1.json();

// Page 2 — pass nextCursor from the previous response
const page2 = await fetch(
  `/api/content/v1/posts?limit=10&cursor=${nextCursor}`,
  { ... }
);

// Stop when nextCursor is null
if (nextCursor === null) { /* no more pages */ }

npm package

Install the official rankboost npm package for a typed wrapper around the Content API.

npm install rankboost
# or
yarn add rankboost
# or
pnpm add rankboost

import rankboost from "rankboost";

const blog = rankboost(process.env.RANKBOOST_API_KEY!);

// Fetch site info
const site = await blog.getSite();

// List posts (page 1)
const { posts, nextCursor } = await blog.getPosts({ limit: 10 });

// Fetch all posts (auto-paginates)
const allPosts = await blog.getAllPosts();

// Fetch a single post by slug
const post = await blog.getPost("my-seo-article-slug");

All methods return typed responses matching the shapes documented above. The package re-exports ContentApiPost and ContentApiSite TypeScript types.

Errors & rate limits

Error responses always return JSON with an error object:

{
  "error": {
    "code":    "NOT_FOUND",
    "message": "Post not found."
  }
}

API keys

API keys authenticate requests to the Content API. Each key is scoped to a single website.

RANKBOOST_API_KEY=rbk_…

To revoke a key, click Revoke next to it in the dashboard. Revoked keys return 401 immediately — useful for rotating secrets or decommissioning environments.