API documentation

API documentation

Endpoints

• Index GET
• Signup form GET
• Signup processor POST
• Login form GET
• Login processor POST
• Logout page GET
• Public bookmark listing GET
• Snapshot view with details GET
• Add bookmark POST
• Add resource POST
• Check bookmark GET
• View bookmark GET
• API documentation GET
• Profile page GET
• Profile page POST
• Generate addon token GET
• Delete addon token POST
• View personal bookmarks GET
• Edit bookmark GET
• Save bookmark POST
• Delete snapshot POST
• Delete bookmark POST
• Add tag POST
• Delete tag POST

Index GET

GET /

Landing page

---

Signup form GET

GET /signup

Signup page

---

Signup processor POST

POST /signup

Signup form processor

Arguments

Name	Type	Required	Description
username	string	true	Username of the new account
email	string	true	Email address of the new account

---

Login form GET

GET /login

Login page

---

Login processor POST

POST /login

Login form processor

Arguments

Name	Type	Required	Description
username	string	true	Username or email address of the new account

---

Logout page GET

GET /logout

Destroys user session

---

Public bookmark listing GET

GET /bookmarks

Displays public bookmarks with optional filters

Arguments

Name	Type	Required	Description
query	string	false	Search term to filter bookmarks by title
owner	string	false	Search term to filter bookmarks by username
tag	string	false	Search term to filter bookmarks by tag
domain	string	false	Search term to filter bookmarks by domain
from	date	false	Display only newer bookmarks. (Format: YYYY.MM.DD)
to	date	false	Display only older bookmarks. (Format: YYYY.MM.DD)
search_in_snapshots	boolean	false	Query parameter also applied to snapshot content. (Values: 0, 1)
search_in_notes	boolean	false	Query parameter also applied to bookmark notes. (Values: 0, 1)

---

Snapshot view with details GET

GET /snapshot

Displays bookmark snapshots with additional bookmark properties

Arguments

Name	Type	Required	Description
sid	string	true	Snapshot key
bid	int	true	Bookmark ID

---

Add bookmark POST

POST /add_bookmark

Add new bookmark

Arguments

Name	Type	Required	Description
token	string	true	Extension token. It can be found on the profile page
url	URL	true	URL of the bookmark
title	string	true	Title of the bookmark
notes	string	false	Bookmark notes
favicon	string	false	Data URL encoded favicon (https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
public	boolean	false	Marks bookmark as public
tags	string	false	Comma separated list of tags
snapshot_title	string	false	Title of the snapshot
snapshot_text	string	false	Text content of the snapshot
snapshot	multipart file	false	Snapshot file

---

Add resource POST

POST /add_resource

Add new resource to a snapshot

Arguments

Name	Type	Required	Description
token	string	true	Extension token. It can be found on the profile page
sid	string	true	Snapshot ID
meta	JSON string	true	List of resource metadata containing objects with mimetype, extension and filename information
resource[0-9]+	multipart files	true	Resource files

---

Check bookmark GET

GET /check_bookmark

Checks if a bookmark is already exists

Arguments

Name	Type	Required	Description
token	string	true	Extension token. It can be found on the profile page
url	URL	true	URL of the bookmark

---

View bookmark GET

GET /bookmark

Displays all details of a bookmark

Arguments

Name	Type	Required	Description
id	int	true	Bookmark ID

---

API documentation GET

GET /api

Displays API documentation (this page)

---

Profile page GET

GET /profile

Displays the profile page

Authentication required

---

Profile page POST

POST /profile

Displays the profile page with addon tokens

Authentication required

---

Generate addon token GET

GET /generate_addon_token

Creates a new addon token

Authentication required

---

Delete addon token POST

POST /delete_addon_token

Deletes an addon token

Authentication required

Arguments

Name	Type	Required	Description
id	int	true	Token ID

---

View personal bookmarks GET

GET /my_bookmarks

Displays bookmarks belongs to the current user with optional filters

Authentication required

Arguments

Name	Type	Required	Description
query	string	false	Search term to filter bookmarks by title
tag	string	false	Search term to filter bookmarks by tag
domain	string	false	Search term to filter bookmarks by domain
from	date	false	Display only newer bookmarks. (Format: YYYY.MM.DD)
to	date	false	Display only older bookmarks. (Format: YYYY.MM.DD)
is_public	boolean	false	Display only public bookmarks. (Values: 0, 1)
is_private	boolean	false	Display only private bookmarks. (Values: 0, 1)
search_in_snapshots	boolean	false	Query parameter also applied to snapshot content. (Values: 0, 1)
search_in_notes	boolean	false	Query parameter also applied to bookmark notes. (Values: 0, 1)

---

Edit bookmark GET

GET /edit_bookmark

Displays a bookmark with all the editable properties

Authentication required

Arguments

Name	Type	Required	Description
id	int	true	Bookmark ID

---

Save bookmark POST

POST /save_bookmark

Saves an edited bookmark

Authentication required

Arguments

Name	Type	Required	Description
id	int	true	Bookmark ID
title	string	true	Title of the bookmark
notes	string	false	Bookmark notes
public	boolean	false	Bookmark is publicly accessible. (Omit this argument in case of private bookmarks)

---

Delete snapshot POST

POST /delete_snapshot

Deletes a snapshot

Authentication required

Arguments

Name	Type	Required	Description
bid	int	true	Bookmark ID
sid	int	true	Snapshot ID

---

Delete bookmark POST

POST /delete_bookmark

Deletes a bookmark

Authentication required

Arguments

Name	Type	Required	Description
id	int	true	Bookmark ID

---

Add tag POST

POST /add_tag

Add tag to a bookmark

Authentication required

Arguments

Name	Type	Required	Description
bid	int	true	Bookmark ID
tag	string	true	Tag string

---

Delete tag POST

POST /delete_tag

Delete tag's bookmark

Authentication required

Arguments

Name	Type	Required	Description
bid	int	true	Bookmark ID
tid	int	true	Tag ID

---