API හරහා ප්‍රකාශනය ඕනෑම වෙබ් අඩවියක.

/ දළ විශ්ලේෂණය

ක්‍රියා කරන ආකාරය

Orova මූල පදයක් සඳහා ලිපියක් ලියා අවසන් කළ විට, ඔබ ලියාපදිංචි කළ endpoint URL එකට තනි HTTP POST request එකක් යවයි. Request body එක JSON වන අතර සම්පූර්ණ ලිපිය අඩංගු වේ. ඔබේ endpoint එක ඔබේ පැත්තේ ලිපිය සාදා, ලිපියේ අවසාන පොදු URL එක සමඟ පිළිතුරු දෙයි. WordPress ලිපියක් සඳහා මෙන්ම, Orova එම URL එක ප්‍රකාශිත සබැඳිය ලෙස සුරකියි. WordPress නොවන අඩවියක අත නොගසා ප්‍රකාශනය අවශ්‍ය විට, හෝ ලිපි ගබඩා කරන ආකාරය සම්පූර්ණයෙන් පාලනය කිරීමට කැමති විට මෙය භාවිත කරන්න.

/ සැකසීම

සැකසීම — පියවර හයක්

• 1

  ඔබේ ව්‍යාපෘතියේ “API හරහා සම්බන්ධ කරන්න” සක්‍රිය කරන්න. ඔබේ ව්‍යාපෘතිය විවෘත කරන්න (ව්‍යාපෘති → ඔබේ ව්‍යාපෘතිය → සම්බන්ධතා). WordPress කාඩ්පත අසල API හරහා සම්බන්ධ කරන්න කාඩ්පතක් ඇත. එහි ඔබේ endpoint URL එක ඇතුළත් කරන්න. රහස් යතුරු ක්ෂේත්‍රය විකල්පයි: හිස්ව තැබුවොත් Orova එකක් ජනනය කරයි, නැතහොත් ඔබේ අඩවිය දැනටමත් භාවිත කරන යතුරක් අලවන්න. සුරැකූ පසු, යතුර පිටපත් කරන්න බොත්තමක් සමඟ කාඩ්පතේ පෙන්වයි. ව්‍යාපෘතියක් ප්‍රකාශ කරන්නේ එක් ඉලක්කයකට පමණි — API හරහා සම්බන්ධ කිරීම WordPress බොත්තම අගුළු දමයි, ප්‍රතිලෝමවද එසේමයි.

• 2

  POST පිළිගන්නා endpoint එකක් ගොඩනගන්න. ඔබේම අඩවියේ හෝ සේවාදායකයේ, JSON body සහිත HTTP POST සඳහා සවන් දෙන route එකක් සාදන්න. ව්‍යාපෘතියේ සම්බන්ධතා තිරයට නැවත අලවන්නේ මෙම URL එකයි. Orova අවසන් කරන සෑම ලිපියක් සඳහාම එය එක් වරක් අමතයි.

• 3

  සෑම request එකකම Bearer token සත්‍යාපනය කරන්න. Orova වෙතින් එන සෑම request එකකම ඔබේ ව්‍යාපෘතියේ පෙන්වන නිශ්චිත රහස් යතුර භාවිත කරමින් “Bearer <secret>” ආකාරයේ Authorization header එකක් ඇත. එය ඔබ ගබඩා කළ පිටපත සමඟ සසඳා නොගැළපෙන ඕනෑම දෙයක් ප්‍රතික්ෂේප කරන්න — වෙනත් කිසිවෙකු ඔබේ අඩවියට ලිපි පළ කිරීම නවත්වන්නේ මෙයයි.

• 4

  Payload එකෙන් ලිපිය සාදන්න. JSON body එක කියවා ඔබේ CMS හෝ දත්ත සමුදායේ ලිපියක් සාදන්න: ලිපිය සඳහා title, slug සහ content_html, meta description ලෙස excerpt, ආවරණ රූපය ලෙස featured_image_url, සහ metadata ලෙස keyword / lang / published_at භාවිත කරන්න.

• 5

  ලිපියේ සජීවී URL එක ආපසු දෙන්න. HTTP 200 හෝ 201 සහ { "url": "https://yoursite.com/the-new-article" } JSON body එකක් සමඟ ප්‍රතිචාර දක්වන්න. Orova එම URL එක ලිපියේ ප්‍රකාශිත සබැඳිය ලෙස ගබඩා කරයි. ඔබ 2xx නොවන තත්ත්වයක් ආපසු දුන්නොත්, හෝ url ක්ෂේත්‍රය මඟ හැරියොත්, Orova ප්‍රකාශනය අසාර්ථක ලෙස සලකයි.

• 6

  Optimize එන්ජිමේ යාවත්කාලීන request හසුරුවන්න. Body එකේ action = "update" ඇති විට, target_url (හෝ slug) මඟින් පවතින ලිපිය සොයා එහි title, content_html සහ excerpt තැනින්ම උඩින් ලියන්න — URL නොවෙනස්ව තබන්න. එකම ලිපියට යොමු වන { "url": ... } සමඟ 200 ප්‍රතිචාර දක්වන්න. මෙය තවම හසුරුවන්නේ නැති endpoint නිසා Orova ප්‍රශස්තකරණය අසාර්ථක ලෙස වාර්තා කරනු ඇත; නව ලිපි ප්‍රකාශනය පෙර පරිදිම ක්‍රියා කරයි.

/ ගිවිසුම

Orova යවන request එක

සෑම නිමි ලිපියක්ම මෙලෙස හැඩගැසුණු එක් request එකක් ලෙස පැමිණේ:

POST <your endpoint URL>

Headers:
  Content-Type: application/json
  Authorization: Bearer <secret>     # the secret key shown in Project -> Connections
  User-Agent: Orova-SEO

Body (JSON):
  {
    "title": "...",                  # article headline
    "slug": "...",                   # URL-friendly identifier
    "content_html": "...",           # full article HTML
    "excerpt": "...",                # meta description
    "featured_image_url": "..." | null,
    "keyword": "...",                # target keyword
    "lang": "en",                    # ISO language code
    "published_at": "2026-05-17T09:00:00.482913",  # ISO 8601, UTC, no offset suffix
    "status": "draft"                # optional: "draft" keeps it unpublished
  }
  # Optional fields are left out of the body when empty — never sent as null.

/ යොමුව

Payload ක්ෂේත්‍ර

ප්‍රකාශන (නව ලිපි) request එකක ක්ෂේත්‍ර. මකා දැමීමේ සහ යාවත්කාලීන request එකම endpoint එක නැවත භාවිත කරන්නේ පහත ඒවායේම කොටස්වල පෙන්වන කුඩා body සමඟයි.

යැවීමට කිසිවක් නැති විට විකල්ප ක්ෂේත්‍ර body එකෙන් සම්පූර්ණයෙන්ම ඉවත් කෙරේ — Orova කිසිවිටෙක null යවන්නේ නැත, එබැවින් ඒවා ආරක්ෂාකාරීව කියවන්න. status ද විකල්පයි: "draft" ලිපිය කෙටුම්පතක් ලෙස සාදන අතර, "publish" හෝ status කිසිසේත් නැතිනම් එය වහාම ප්‍රකාශ කරයි.

/ ගිවිසුම

ඔබ ආපසු දිය යුතු response එක

ලිපිය සෑදූ පසු, HTTP 200 හෝ 201 තත්ත්වයක් සහ මෙම JSON body එක සමඟ පිළිතුරු දෙන්න:

HTTP 200 (or 201)
Content-Type: application/json

{
  "url": "https://yoursite.com/published-article"
}

Orova එම url එක ලිපියේ ප්‍රකාශිත සබැඳිය ලෙස ගබඩා කරයි. ඔබේ endpoint එක 2xx නොවන ඕනෑම තත්ත්වයක්, හෝ url ක්ෂේත්‍රයක් සහිත JSON object එකක් නොවන body එකක් ආපසු දුන්නොත්, Orova ප්‍රකාශනය අසාර්ථක ලෙස සලකා ඔබට නැවත උත්සාහ කළ හැකි වන සේ ලිපිය ඒ අනුව සලකුණු කරයි. තත්පර 60 ක් ඇතුළත පිළිතුරු දෙන්න — ඉන්පසු Orova request එක කල් ඉකුත් කරයි (මෙය ප්‍රකාශනය, යාවත්කාලීනය සහ මකා දැමීම යන සියල්ලටම අදාළයි).

/ උදාහරණය

කේත උදාහරණය

Express සහිත Node.js හි අවම ලබන endpoint එකක්. එකම පියවර — token සත්‍යාපනය, action (update / delete) අනුව ශාඛා කිරීම, ලිපිය සෑදීම හෝ වෙනස් කිරීම, URL ආපසු දීම — ඕනෑම භාෂාවකට හෝ framework එකකට අදාළයි.

// Node.js / Express — a minimal receiving endpoint
import express from "express";

const app = express();
app.use(express.json({ limit: "5mb" }));

// The secret Orova generated for this project.
const OROVA_SECRET = process.env.OROVA_SECRET;

app.post("/orova/publish", async (req, res) => {
  // 1. Verify the Bearer token.
  const auth = req.get("authorization") || "";
  if (auth !== "Bearer " + OROVA_SECRET) {
    return res.status(401).json({ error: "unauthorized" });
  }

  // 2. Required: list your articles (duplicate check, internal links). action = "list".
  if (req.body.action === "list") {
    const posts = await listPosts(req.body.limit || 500); // newest first, 500 max
    // each post: { id, title, slug, link, date, modified, status, author, excerpt? }
    return res.status(200).json({ ok: true, posts });
  }

  // 3. Required: read one article in full (used when optimizing it). action = "get".
  if (req.body.action === "get") {
    const post = await findPost(req.body.id, req.body.target_url, req.body.slug);
    if (!post) return res.status(404).json({ ok: false, err: "not_found" });
    return res.status(200).json({ ok: true, post });
  }

  // 4. Visual Editor: store an image, answer with its absolute URL.
  if (req.body.action === "upload_image") {
    const { filename, mime, data_base64 } = req.body;
    if (!String(mime || "").startsWith("image/")) {
      return res.status(422).json({ error: "image files only" });
    }
    const bytes = Buffer.from(data_base64, "base64");
    if (bytes.length > 15 * 1024 * 1024) {
      return res.status(413).json({ error: "image too large" });
    }
    return res.status(200).json({ ok: true, url: await saveImage(filename, bytes) });
  }

  // 5. Delete requests: body carries action = "delete".
  if (req.body.action === "delete") {
    const removed = await deletePostByUrl(req.body.url, req.body.slug);
    if (!removed) return res.status(404).json({ deleted: true }); // already gone
    return res.status(200).json({ deleted: true });
  }

  // 6. Update requests: action = "update". Optional fields may be absent.
  if (req.body.action === "update") {
    const updated = await updatePost(req.body.id, req.body.target_url, {
      title: req.body.title,
      html: req.body.content_html,
      metaDescription: req.body.excerpt,
      coverImage: req.body.featured_image_url,  // optional
      status: req.body.status,                  // optional: "publish" | "draft"
    });
    if (!updated) return res.status(404).json({ error: "post not found" });
    return res.status(200).json({ url: updated.url });
  }

  // 7. New article: read the payload Orova sent.
  const {
    title, slug, content_html, excerpt,
    featured_image_url, keyword, lang, published_at, status,
  } = req.body;

  // 8. Create the article in your own CMS or database.
  const post = await createPost({
    title,
    slug,
    html: content_html,
    metaDescription: excerpt,
    coverImage: featured_image_url,
    keyword,
    lang,
    publishedAt: published_at,
    draft: status === "draft",   // status is optional; absent means publish now
  });

  // 9. Return 200/201 with the live URL.
  return res.status(201).json({
    url: "https://yoursite.com/" + post.slug,
  });
});

app.listen(3000);

/ ගිවිසුම — යාවත්කාලීනය

ලිපි යාවත්කාලීන කිරීම (Optimize)

Orova හි Optimize එන්ජිම දැනටමත් සජීවී ලිපි නැවත ලියයි — නැවුම් කළ කරුණු, වඩා හොඳ මාතෘකා, ඒකාබද්ධ අන්තර්ගතය — ඉන්පසු පවතින ලිපිය තැනින්ම, URL නොවෙනස්ව තබමින් උඩින් ලියයි. Request එක යන්නේ එකම endpoint URL එකට, එකම Bearer token සමඟ POST එකක් ලෙසයි:

POST <your endpoint URL>

Headers:
  Content-Type: application/json
  Authorization: Bearer <secret>
  User-Agent: Orova-SEO

Body (JSON):
  {
    "action": "update",          # always the literal string "update"
    "id": 123,                   # optional: post id, match on this first
    "target_url": "...",         # public URL of the post to overwrite (match next)
    "title": "...",              # new headline
    "slug": "...",               # slug fallback for matching, may be empty
    "content_html": "...",       # full new article body as HTML
    "excerpt": "...",            # new meta description
    "featured_image_url": "...", # optional: new cover image
    "status": "publish"          # optional: "publish" or "draft"
  }
  # Optional fields are left out of the body when empty — never sent as null.

target_url මඟින් ලිපිය සොයන්න (නැතිනම් slug), එහි title, body සහ meta description ප්‍රතිස්ථාපනය කරන්න, URL එලෙසම තබන්න, ඉන්පසු { "url": "<same post URL>" } සමඟ 200 ප්‍රතිචාර දක්වන්න. 2xx නොවන ඕනෑම තත්ත්වයක්, හෝ url නොමැති body එකක්, Orova හට එම ප්‍රශස්තකරණය අසාර්ථක ලෙස සලකුණු කිරීමට හේතු වේ (එය කිසිවිටෙක අනුපිටපත් ලිපියක් සාදන්නේ නැත). මෙය තවම ක්‍රියාත්මක කර නැති endpoint නව ලිපි නොවෙනස්ව ප්‍රකාශ කරයි — update ක්‍රියාත්මක කිරීම අවශ්‍ය වන්නේ ඔබ Optimize තිරය භාවිත කරන විට පමණි.

අගෝස්තු 29 සිට update body එකේ id (target_url ට පෙර එය මත ගළපන්න), නව ආවරණ රූපයක් සඳහා featured_image_url, සහ "publish" හෝ "draft" රඳවන status ද තිබිය හැක. තුනම විකල්පයි; හිස් විට ඒවා body එකෙන් ඉවත් කෙරේ, කිසිවිටෙක null ලෙස යවන්නේ නැත.

/ ගිවිසුම — Visual Editor

ලිපි කියවීම (අනිවාර්යයි)

අනුපිටපත් මාතෘකා වළක්වා ගැනීමට, අභ්‍යන්තර සබැඳි එක් කිරීමට සහ පැරණි ලිපි ප්‍රශස්ත කිරීමට Orova හට ඔබේ අඩවියේ දැනටමත් ඇති ලිපි කියවීමට අවශ්‍යයි. එකම endpoint URL එකේ, එකම Bearer token සමඟ තවත් ක්‍රියා දෙකක් එක් කරන්න: list ඔබේ ලිපි ආපසු දෙයි, get ඉන් එකක් සම්පූර්ණයෙන් ආපසු දෙයි.

POST <your endpoint URL>     # same endpoint, same Bearer secret

Body (JSON):
  {
    "action": "list",            # always the literal string "list"
    "limit": 500                 # newest article first, 500 maximum
  }

Response — HTTP 200:
  {
    "ok": true,
    "posts": [
      {
        "id": 123,               # your own post id, reused by "get" and "update"
        "title": "...",
        "slug": "...",
        "link": "https://yoursite.com/the-article",
        "date": "2026-08-29",    # published date, YYYY-MM-DD
        "modified": "2026-08-29",
        "status": "publish",     # "publish" or "draft"
        "author": "...",
        "excerpt": "..."         # optional: short summary, 300 characters max
      }
    ]
  }
  # Required: Orova reads this list to avoid duplicate topics,
  # add internal links and analyze the whole site.

POST <your endpoint URL>

Body (JSON):
  {
    "action": "get",             # always the literal string "get"
    "id": 123,                   # match on this first
    "target_url": "...",         # then the public URL
    "slug": "..."                # then the slug
  }

Response — HTTP 200:
  {
    "ok": true,
    "post": {
      "id": 123,
      "title": "...",
      "slug": "...",
      "link": "https://yoursite.com/the-article",
      "content_html": "...",     # full article body as HTML
      "excerpt": "...",
      "featured_image_url": "...",
      "status": "publish"        # "publish" or "draft"
    }
  }

No such post — HTTP 404:
  { "ok": false, "err": "not_found" }

limit උපරිමය 500 වන අතර නවතම ලිපිය මුලින්ම එයි. get සඳහා, Orova id, target_url සහ slug එකට යවයි — එම පිළිවෙළින්, ඔබ හඳුනාගන්නා ඕනෑම එකක් මත ගළපන්න. කිසිවක් නොගැළපෙන විට, { "ok": false, "err": "not_found" } සමඟ 404 පිළිතුරු දෙන්න. list හි excerpt විකල්පයි (උපරිම අක්ෂර 300). අනිවාර්යයි: දැනටමත් පවතින ලිපි මොනවාදැයි දැනගැනීමට (අනුපිටපත් වළක්වා ගැනීමට, අභ්‍යන්තර සබැඳි එක් කිරීමට සහ මුළු අඩවියම විශ්ලේෂණය කිරීමට) Orova list අමතන අතර, ලිපියක් ප්‍රශස්ත කරන විට එය කියවීමට get අමතයි. ඔබේ අඩවිය මෙම ක්‍රියා දෙකට පිළිතුරු නොදෙන්නේ නම්, නව ලිපිවලට අභ්‍යන්තර සබැඳි නොලැබෙන අතර පැරණි ලිපි ප්‍රශස්ත කළ නොහැක.

/ ගිවිසුම — Visual Editor

රූප උඩුගත කිරීම (Visual Editor)

ඔබ Visual Editor එකට රූපයක් දැමූ විට, Orova එය JSON body එක තුළ base64 ලෙස එකම endpoint URL එකට යවයි — multipart නැත, ආරක්ෂා කිරීමට දෙවන URL එකක් නැත.

POST <your endpoint URL>

Body (JSON):
  {
    "action": "upload_image",    # always the literal string "upload_image"
    "filename": "cover.png",     # original file name, extension included
    "mime": "image/png",         # image/* only
    "data_base64": "iVBORw0KGgo..."   # file bytes, base64, 15 MB maximum
  }

Response — HTTP 200 (or 201):
  {
    "ok": true,
    "url": "https://yoursite.com/uploads/cover.png"   # absolute URL
  }

image/* පමණක් පිළිගෙන 15 MB ට වැඩි ඕනෑම දෙයක් ප්‍රතික්ෂේප කරන්න. ගොනුව ගබඩා කර, රූපයේ නිරපේක්ෂ URL එක සමඟ පිළිතුරු දෙන්න: සාපේක්ෂ මාර්ගයක් ලිපිය වෙනත් තැනක දර්ශනය වූ වහාම එය බිඳ දමයි. මෙම ක්‍රියාව අවශ්‍ය වන්නේ Visual Editor සඳහා පමණි.

/ ගිවිසුම — මකා දැමීම

ලිපි මකා දැමීම

පරිශීලකයෙකු Orova තුළ (ලියන්න හෝ වාර්තා තිරයෙන්) ප්‍රකාශිත ලිපියක් ඉවත් කළ විට, Orova ඔබේ අඩවියටද එය මකා දමන ලෙස ඉල්ලයි. Request එක යන්නේ එකම endpoint URL එකට, එකම Bearer token සමඟ POST එකක් ලෙසයි — එකම වෙනස body එකයි:

POST <your endpoint URL>

Headers:
  Content-Type: application/json
  Authorization: Bearer <secret>
  User-Agent: Orova-SEO

Body (JSON):
  {
    "action": "delete",          # always the literal string "delete"
    "url": "...",                # public URL of the article to remove (match on this first)
    "slug": "...",               # slug fallback, may be empty
    "keyword": "..."             # the article's target keyword, for your logs
  }

url මඟින් ලිපිය සොයන්න (නැතිනම් slug), එය ඉවත් කරන්න හෝ ප්‍රකාශනයෙන් ඉවත් කරන්න, ඉන්පසු 200 සහ { "deleted": true } සමඟ ප්‍රතිචාර දක්වන්න — හිස් 204 එකක්ද ක්‍රියා කරයි. ලිපිය තවදුරටත් නොපවතී නම්, 404 පිළිතුරු දෙන්න, Orova එය දැනටමත් මකා දැමූ ලෙස සලකයි. { "deleted": false } ආපසු දීමෙන් ලිපිය ඉවත් නොකළ බව Orova හට කියයි. සාමාන්‍ය ප්‍රකාශන request වල කිසිවිටෙක action ක්ෂේත්‍රයක් නැත, එබැවින් පවතින endpoint නොවෙනස්ව ක්‍රියා කරයි — delete ක්‍රියාත්මක කිරීම විකල්ප නමුත් නිර්දේශිතයි.

/ ආරක්ෂාව

ආරක්ෂක සටහන්

• සැමවිටම Bearer token සත්‍යාපනය කරන්න. ඔබේ endpoint එක පොදු URL එකකි — ඕනෑම අයෙකුට එය ඇමතිය හැක. Request එකක් සැබවින්ම Orova වෙතින් පැමිණි බව ඔප්පු කරන එකම දෙය Authorization header එකයි, එබැවින් token එක ඔබ ගබඩා කළ රහස සමඟ හරියටම නොගැළපෙන සෑම request එකක්ම ප්‍රතික්ෂේප කරන්න.
• Endpoint එක HTTPS හරහා සපයන්න. රහස ගමන් කරන්නේ header එකක. HTTPS එය ගමනේදී කියවීමෙන් ආරක්ෂා කරයි.
• රහස ඔබේ කේතයෙන් පිටත තබන්න. එය පරිසර විචල්‍යයක හෝ රහස් කළමනාකරුවෙකු තුළ ගබඩා කරන්න, ඔබ commit කරන ගොනුවක කිසිවිටෙක hard-code නොකරන්න. එය කවදා හෝ හෙළි වුවහොත්, ව්‍යාපෘතිය → සම්බන්ධතා වෙතින් අලුත් එකක් ජනනය කරන්න.
• content_html විශ්වාසදායක markup ලෙස නොව අන්තර්ගතයක් ලෙස සලකන්න. ඔබේ CMS හි ඕනෑම ලිපි අන්තර්ගතයක් මෙන්ම එයද සැලකිල්ලෙන් ගබඩා කර දර්ශනය කරන්න.

/ අවසාන වශයෙන්

සම්පූර්ණ ගිවිසුම එපමණයි

Endpoint එක සජීවීව ඔබේ ව්‍යාපෘතියේ ලියාපදිංචි කළ පසු, Orova ඔබේ අඩවියට ස්වයංක්‍රීයව ප්‍රකාශ කරයි — WordPress පරිශීලකයින්ට කරන ආකාරයටම. එය අවසන් කරන සෑම ලිපියක්ම ඔබේ සේවාදායකයට පැමිණ ලිපියක් බවට පත් වන අතර, එහි පොදු URL එක වාර්තා සහ විශ්ලේෂණය වෙත ආපසු ගලා එන බැවින් එහි කාර්ය සාධනය නිරීක්ෂණය කළ හැක.