Custom API
Schema Generator for Custom API
HaloSEO builds the JSON-LD for a page and refuses to emit a type whose required fields are missing. This page explains how that works with a Custom API site.
How HaloSEO connects to Custom API
You connect your site to HaloSEO and HaloSEO researches the keywords, writes the posts, publishes them, links them up and builds the backlinks. For a Custom API site, the connection runs through your own API. You give HaloSEO an endpoint and a credential that can create and update posts. That credential needs write access to posts only. It does not need admin access, user management or billing. If your API uses scoped tokens, issue one scope for content and nothing else. The schema generator itself needs no connection at all. It is a tool you run and paste the output from.
What the published post looks like on a Custom API site
The post is created through your API as a normal post record. Your theme renders it. HaloSEO does not ship a template and does not override your styles. Headings, lists, images and links arrive as standard content fields, so they inherit your fonts, spacing and colours. The JSON-LD from the schema generator is a separate block you add yourself. It does not appear in the visible page. It sits in the head or in a script tag your theme already supports.
What happens on Custom API that does not happen elsewhere
On a hosted platform the publishing step is fixed. On a Custom API site you control the write path. That means you decide which fields map to which content, whether a draft is created first, and what status a post gets on creation. You can route posts through your own review step before they go live. You can also reject a write and return an error, and HaloSEO will surface it. The schema generator is the same tool everywhere. The difference is that you own the endpoint it feeds into.
What breaks, and what happens when it does
The schema generator refuses to emit a type whose required fields are missing. You get no output rather than invalid JSON-LD, so a broken block never reaches your page. On the publishing side, a write can fail if the token expires, if the endpoint changes, or if your API rejects a field. When that happens the post is not published and the error is reported back to you. Nothing is retried silently against a different endpoint. Fix the credential or the field mapping and run it again.
Who this is not right for
This is not right for you if you want schema added to published posts automatically. HaloSEO does not do that yet. The generator is a tool you paste the output from, so someone has to take the JSON-LD and put it on the page. It is also not right for you if you cannot issue a scoped API credential, or if your site has no API to publish to. In those cases the connection has nothing to talk to.
Related
the platform
the feature
same feature, another platform
How it runs, once it is connected
You do the first step. HaloSEO does the other six, on its own, every week.
- 01
Connect your website
- 02
HaloSEO researches keywords
- 03
Writes blog posts
- 04
Publishes automatically
- 05
Creates internal links
- 06
Builds backlinks
- 07
Improves rankings on Google and AI search engines