API-only access to CRUD comments

dshomoye 5y, 24d ago [edited]

I know this might seem a bit counter to the goal but is there any plans (or chance) of allowing (JSON?) API access to the comments. My main motivation is to be able to call the api per page and also have easier control over the presentation of the UI (dark/light mode for example).

Comments

timehexon 39d, 8h ago [edited]

A full JSON REST API is now live. You can list threads, read threads with replies, create threads, reply, edit, and authenticate -- all via JSON endpoints at /api/v1/.

There's also a Python client you can grab with one command (no pip install, stdlib only):

curl -s https://my.remarkbox.com/api/v1/clients/python -o remarkbox_client.py

Quick example:

from remarkbox_client import RemarkboxClient
client = RemarkboxClient("https://my.remarkbox.com")
threads = client.list_threads("meta.remarkbox.com")

Authentication uses the same passwordless email OTP as the web UI. Each namespace has an "Allow API Access" toggle in settings, and rate limiting is configurable per deploy. Full docs are in docs/api.md in the repository.

Full details: https://git.unturf.com/engineering/remarkbox/remarkbox/-/blob/main/docs/tickets/12.md

remark

russell 5y, 20d ago [edited]

For read only operations we have a cache-able endpoint which returns all threads and comments in a single JSON endpoint.

Look at your Namespace setting for more details.

No endpoints are currently planned for API crud interactions but I understand the desire and benefit and will think about the possibility.

I'm looking to build a toggle button for dark mode.

remark