REST API

Starting with version 4.8.0, the SEO Check features a REST API that can be used to get information about a Sophora document.

Get Document Information

Depending on your installation, the following URL can be used to access document information:
(replace SOPHORA-ID with a document's Sophora ID, for example, article-100)

http://localhost:8080/rest/document/SOPHORA-ID

Example Response

{
	"uuid": "3abe6a0b-335a-482a-a902-c9245a57ecc6",
	"externalId": "3abe6a0b-335a-482a-a902-c9245a57ecc6",
	"title": "Implementing Functional State Machines with Go",
	"seoKeywordsSaved": [
		"state machine",
		"golang",
		"programming"
	],
	"seoKeywordsSynonyms": [
		"plan",
		"programme",
		"computer program",
		"computer programme",
		"programme"
	],
	"seoScore": {
		"total": 0.47,
		"groups": {
			"keywords": 1.0,
			"document": 0.25,
			"copytextLinks": 0.2,
			"copytext": 0.8,
			"images": 0.25,
			"medias": 0.29
		}
	},
	"fleschScore": 80.89016906474822,
	"seoKeywordsRelated": [
		"fsm",
		"state machine",
		"finite state machine",
		"state machine diagram",
		"statemachine"
	],
	"suggestedKeywords": [
		"Function",
		"rune",
		"parse",
		"machine"
	]
}

API Documentation

To access the API's documentation, please visit the following URL:

http://localhost:8080/doc/swagger-ui/index.html