Artalk API (1.0)

Download OpenAPI specification:Download

API Support: artalkjs@gmail.com URL: https://artalk.js.org License: LGPL-3.0

This is an Artalk server.

Comment

Comment Add

Create a new comment

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

name	string the comment name
email	string the comment email
link	string the comment link
content required	string the comment content
rid	string the comment rid
ua	string the comment ua
page_key required	string the comment page_key
page_title	string the comment page_title
site_name	string the site name of your content scope

Responses

Comment Delete

Delete a specific comment

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id required	integer the comment ID you want to delete
site_name	string the site name of your content scope

Responses

Comment Edit

Edit a specific comment

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id required	integer the comment ID you want to edit
site_name	string the site name of your content scope
content	string the comment content
page_key	string the comment page_key
nick	string the comment nick
email	string the comment email
link	string the comment link
rid	string the comment rid
ua	string the comment ua
ip	string the comment ip
is_collapsed	boolean the comment is_collapsed
is_pending	boolean the comment is_pending
is_pinned	boolean the comment is_pinned

Responses

Comment List

Get a list of comments by some conditions

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

page_key required	string the comment page_key
site_name	string the site name of your content scope
limit	integer the limit for pagination
offset	integer the offset for pagination
flat_mode	boolean enable flat_mode
sort_by	string Enum: "date_asc" "date_desc" "vote" sort by condition
view_only_admin	boolean only show comments by admin
search	string search keywords
type	string Enum: "all" "mentions" "mine" "pending" "admin_all" "admin_pending" message center show type
name	string the username
email	string the user email

Responses

Cache

Cache Flush

Flush Cache when application runs

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

flush_all

integer

flush all cache

Responses

Cache Warming

Cache warming helps you hit the cache on the user's first visit

Authorizations:

ApiKeyAuth

Responses

Transfer

Transfer Export

Export data from Artalk

Authorizations:

ApiKeyAuth

Responses

Transfer Import

Import data to Artalk

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

payload

string

the transfer importer payload

Responses

Transfer Import Upload

Upload a file to prepare to import

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

file

required

string <binary>

upload file in preparation for import task

Responses

Page

Page Delete

Delete a specific page

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

key required	string the page KEY you want to delete
site_name	string the site name of your content scope

Responses

Page Edit

Edit a specific page

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id required	string the page ID you want to edit
site_name	string the site name of your content scope
key	string edit page key
title	string edit page title
admin_only	boolean edit page admin_only option

Responses

Page Data Fetch

Fetch the data of a specific page

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

key required	string the page ID you want to fetch
site_name	string the site name of your content scope
get_status	boolean which response data you want to receive

Responses

Page List

Get a list of pages by some conditions

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

site_name	string the site name of your content scope
limit	integer the limit for pagination
offset	integer the offset for pagination

Responses

System

Email Send

Send an email to test the email sender

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

subject required	string the subject of email
body required	string the body of email
to_addr required	string the email address of the receiver

Responses

Settings Get

Get settings from app config file

Authorizations:

ApiKeyAuth

Responses

Settings Save

Save settings to app config file

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

data

required

string

the content of the config file in YAML format

Responses

Settings Template

Get config templates in different languages for rendering the settings page in the frontend

Authorizations:

ApiKeyAuth

Responses

Config

Get system configurations

Responses

Version

Get the version of Artalk

Responses

Site

Site Add

Create a new site

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

name	string the site name
urls	string the site urls

Responses

Site Delete

Delete a specific site

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id

required

string

the site ID you want to delete

Responses

Site Edit

Edit a specific site

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id required	string the site ID you want to edit
name	string edit site name
urls	string edit site urls

Responses

Site List

Get a list of sites by some conditions

Authorizations:

ApiKeyAuth

Responses

User

User Add

Create a new user

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

name required	string the user name
email required	string the user email
password	string the user password
link	string the user link
is_admin required	boolean the user is an admin
site_names	string the site names associated with the user
receive_email required	boolean the user receive email
badge_name	string the user badge name
badge_color	string the user badge color (hex format)

Responses

User Delete

Delete a specific user

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id

required

string

the user ID you want to delete

Responses

User Edit

Edit a specific user

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

id required	string the user ID you want to edit
name required	string the user name
email required	string the user email
password	string the user password
link	string the user link
is_admin required	boolean the user is an admin
site_names	string the site names associated with the user
receive_email required	boolean the user receive email
badge_name	string the user badge name
badge_color	string the user badge color (hex format)

Responses

User List

Get a list of users by some conditions

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

limit	integer the limit for pagination
offset	integer the offset for pagination

Responses

User Login

Login user by name or email

Request Body schema: application/x-www-form-urlencoded

name	string the username
email required	string the user email
password required	string the user password

Responses

User Login Status

Get user login status by header Authorization

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

name	string the username
email	string the user email
password required	string the user password

Responses

User Logout

Logout current user (applies to cookie identification only) User Logout

Responses

User Info Get

Get user info to prepare for login or check current user status

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

name	string the username
email	string the user email

Responses

Vote

Vote Sync

Sync the number of votes in the comments or pages data tables to keep them the same as the votes table

Authorizations:

ApiKeyAuth

Responses

Vote

Vote for a specific comment or page

Request Body schema: application/x-www-form-urlencoded

target_id required	integer target comment or page ID you want to vote for
type required	string Enum: "comment_up" "comment_down" "page_up" "page_down" the type of vote target
name	string the username
email	string the user email
site_name	string the site name of your content scope

Responses

Captcha

Captcha Check

Verify user enters correct captcha code

Request Body schema: application/x-www-form-urlencoded

value

required

string

the captcha value to check

Responses

Captcha Get

Get a base64 encoded captcha image or a HTML page to verify for user

Responses

Captcha Get

Get a base64 encoded captcha image or a HTML page to verify for user

Responses

Captcha Get

Get a base64 encoded captcha image or a HTML page to verify for user

Responses

Captcha Status

Get the status of the user's captcha verification

Responses

Upload

Image Upload

Upload image from this endpoint

Authorizations:

ApiKeyAuth

Request Body schema: application/x-www-form-urlencoded

file required	string <binary> upload file in preparation for import
name required	string the username
email required	string the user email
page_key required	string the page key
page_title	string the page title
site_name	string the site name of your content scope

Responses

Notify

Notify Mark Read

Mark specific notification as read for user

Request Body schema: application/x-www-form-urlencoded

comment_id required	integer the comment id of the notify you want to mark as read
notify_key required	string the key of the notify
name	string the username
email	string the user email
all_read	boolean the option if mark all user's notify as read
site_name	string the site name of your content scope

Responses

PV

Page View

Log and get the number of page views

Request Body schema: application/x-www-form-urlencoded

page_key required	string the page key
page_title	string the page title
site_name	string the site name of your content scope

Responses

Statistics

Get the statistics of various data analysed

Request Body schema: application/x-www-form-urlencoded

type required	string Enum: "latest_comments" "latest_pages" "pv_most_pages" "comment_most_pages" "page_pv" "site_pv" "page_comment" "site_comment" "rand_comments" "rand_pages" the type of statistics
page_keys	string multiple page keys separated by commas
site_name	string the site name of your content scope
limit	integer the amount of items you want