Halo-Plus API Documentation (1.0.1)

Download OpenAPI specification:Download

nineya: blog@nineya.com URL: https://github.com/nineya/halo-plus/issues License: GNU General Public License v3.0 Terms of Service

Documentation for Halo-Plus API

archive-controller

Archive Controller

listMonthArchives

Authorizations:

api_access_keyAPI-Authorization

Responses

listYearArchives

Authorizations:

api_access_keyAPI-Authorization

Responses

category-controller

Category Controller

Lists categories

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings
more	boolean more

Responses

Lists posts by category slug

Authorizations:

api_access_keyAPI-Authorization

path Parameters

slug

required

string

slug

query Parameters

page	integer <int32>
size	integer <int32>
sort	Array of strings
password	string password

Responses

journal-controller

Journal Controller

Lists journals

Authorizations:

api_access_keyAPI-Authorization

query Parameters

page	integer <int32>
size	integer <int32>
sort	Array of strings

Responses

Comments a post

Authorizations:

api_access_keyAPI-Authorization

Request Body schema: application/json

allowNotification	boolean
author required	string [ 0 .. 50 ] characters
authorUrl	string [ 0 .. 255 ] characters
content required	string [ 0 .. 1023 ] characters
email	string [ 0 .. 255 ] characters
parentId	integer <int64>
postId	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"allowNotification": true,
"author": "string",
"authorUrl": "string",
"content": "string",
"email": "string",
"parentId": 0,
"postId": 0
}

Likes a journal

Authorizations:

api_access_keyAPI-Authorization

path Parameters

id

required

integer <int32>

id

Responses

Gets a journal detail

Authorizations:

api_access_keyAPI-Authorization

path Parameters

journalId

required

integer <int32>

journalId

Responses

Lists comment with list view

Authorizations:

api_access_keyAPI-Authorization

path Parameters

journalId

required

integer <int32>

journalId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

listTopComments

Authorizations:

api_access_keyAPI-Authorization

path Parameters

journalId

required

integer <int32>

journalId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

Lists comments with tree view

Authorizations:

api_access_keyAPI-Authorization

path Parameters

journalId

required

integer <int32>

journalId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

listChildrenBy

Authorizations:

api_access_keyAPI-Authorization

path Parameters

journalId required	integer <int32> journalId
commentParentId required	integer <int64> commentParentId

query Parameters

sort	Array of strings

Responses

link-controller

Link Controller

List all links

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings

Responses

List all links with team view

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings

Responses

menu-controller

Menu Controller

Lists all menus

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings

Responses

Lists menus with tree view

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings

Responses

option-controller

Option Controller

Options for comment(@deprecated, use /bulk api instead of this.) Deprecated

Authorizations:

api_access_keyAPI-Authorization

Responses

Gets option value by option key

Authorizations:

api_access_keyAPI-Authorization

path Parameters

key

required

string

key

Responses

Lists all options with list view

Authorizations:

api_access_keyAPI-Authorization

Responses

Lists options with map view

Authorizations:

api_access_keyAPI-Authorization

query Parameters

key	string key
keys	string keys

Responses

photo-controller

Photo Controller

pageBy

Authorizations:

api_access_keyAPI-Authorization

query Parameters

keyword	string
page	integer <int32>
size	integer <int32>
sort	Array of strings
team	string

Responses

listPhotos

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings

Responses

Lists all of photo teams

Authorizations:

api_access_keyAPI-Authorization

Responses

post-controller

Post Controller

Lists posts

Authorizations:

api_access_keyAPI-Authorization

query Parameters

page	integer <int32>
size	integer <int32>
sort	Array of strings
keyword	string keyword
categoryId	integer <int32> categoryId

Responses

Comments a post

Authorizations:

api_access_keyAPI-Authorization

Request Body schema: application/json

allowNotification	boolean
author required	string [ 0 .. 50 ] characters
authorUrl	string [ 0 .. 255 ] characters
content required	string [ 0 .. 1023 ] characters
email	string [ 0 .. 255 ] characters
parentId	integer <int64>
postId	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"allowNotification": true,
"author": "string",
"authorUrl": "string",
"content": "string",
"email": "string",
"parentId": 0,
"postId": 0
}

Lists posts by keyword

Authorizations:

api_access_keyAPI-Authorization

query Parameters

keyword required	string keyword
page	integer <int32>
size	integer <int32>
sort	Array of strings

Responses

Gets a post

Authorizations:

api_access_keyAPI-Authorization

query Parameters

slug required	string slug
formatDisabled	boolean formatDisabled
sourceDisabled	boolean sourceDisabled

Responses

Gets a post

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

query Parameters

formatDisabled	boolean formatDisabled
sourceDisabled	boolean sourceDisabled

Responses

Lists comment with list view

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

listTopComments

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

Lists comments with tree view

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

listChildrenBy

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId required	integer <int32> postId
commentParentId required	integer <int64> commentParentId

query Parameters

sort	Array of strings

Responses

Likes a post

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

Responses

Gets next post by current post id.

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

Responses

Gets previous post by current post id.

Authorizations:

api_access_keyAPI-Authorization

path Parameters

postId

required

integer <int32>

postId

Responses

sheet-controller

Sheet Controller

Lists sheets

Authorizations:

api_access_keyAPI-Authorization

query Parameters

page	integer <int32>
size	integer <int32>
sort	Array of strings

Responses

Comments a post

Authorizations:

api_access_keyAPI-Authorization

Request Body schema: application/json

allowNotification	boolean
author required	string [ 0 .. 50 ] characters
authorUrl	string [ 0 .. 255 ] characters
content required	string [ 0 .. 1023 ] characters
email	string [ 0 .. 255 ] characters
parentId	integer <int64>
postId	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"allowNotification": true,
"author": "string",
"authorUrl": "string",
"content": "string",
"email": "string",
"parentId": 0,
"postId": 0
}

Gets a sheet by slug

Authorizations:

api_access_keyAPI-Authorization

query Parameters

slug required	string slug
formatDisabled	boolean formatDisabled
sourceDisabled	boolean sourceDisabled

Responses

Gets a sheet

Authorizations:

api_access_keyAPI-Authorization

path Parameters

sheetId

required

integer <int32>

sheetId

query Parameters

formatDisabled	boolean formatDisabled
sourceDisabled	boolean sourceDisabled

Responses

Lists comment with list view

Authorizations:

api_access_keyAPI-Authorization

path Parameters

sheetId

required

integer <int32>

sheetId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

listTopComments

Authorizations:

api_access_keyAPI-Authorization

path Parameters

sheetId

required

integer <int32>

sheetId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

Lists comments with tree view

Authorizations:

api_access_keyAPI-Authorization

path Parameters

sheetId

required

integer <int32>

sheetId

query Parameters

sort	Array of strings
page	integer <int32> page

Responses

listChildrenBy

Authorizations:

api_access_keyAPI-Authorization

path Parameters

sheetId required	integer <int32> sheetId
commentParentId required	integer <int64> commentParentId

query Parameters

sort	Array of strings

Responses

statistic-controller

Statistic Controller

Gets blog statistics.

Authorizations:

api_access_keyAPI-Authorization

Responses

Gets blog statistics with user

Authorizations:

api_access_keyAPI-Authorization

Responses

tag-controller

Tag Controller

Lists tags

Authorizations:

api_access_keyAPI-Authorization

query Parameters

sort	Array of strings
more	boolean If the param is true, post count of tag will be returned

Responses

Lists posts by tag slug

Authorizations:

api_access_keyAPI-Authorization

path Parameters

slug

required

string

slug

query Parameters

page	integer <int32>
size	integer <int32>
sort	Array of strings

Responses

theme-controller

Theme Controller

Gets activated theme property

Authorizations:

api_access_keyAPI-Authorization

Responses

Lists activated theme settings

Authorizations:

api_access_keyAPI-Authorization

Responses

Gets theme property by theme id

Authorizations:

api_access_keyAPI-Authorization

path Parameters

themeId

required

string

themeId

Responses

Lists theme settings by theme id

Authorizations:

api_access_keyAPI-Authorization

path Parameters

themeId

required

string

themeId

Responses

user-controller

User Controller

Gets blogger profile

Authorizations:

api_access_keyAPI-Authorization