API

Jump to bottom Edit New page

Élie Michel edited this page Dec 4, 2014 · 3 revisions

/!\ Warning: The API is going to be refactored. See RFF5 for information.

This page describes the functions available in the API, for AJAX calls in templates for instance.

`api/mark_as_read.php`

This page allows you to mark items as read / unread.

A call to /api/mark_read.php?entry=ENTRY_ID marks as read the item designated by ENTRY_ID.
A call to /api/mark_read.php?entry=ENTRY_ID&unread=1 marks as unread the item designated by ENTRY_ID.
A call to /api/mark_read.php?all=1 marks all the items as read.
A call to /api/mark_read.php?all=1&view=VIEW marks all the items of the view VIEW as read (easy way to mark an entire tag / feed as read).

`api/tags.php`

A call to /api/tags.php?entry=ENTRY_ID&tag=TAG add the tag TAG to the item designated by ENTRY_ID.