mirror of
https://codeberg.org/readeck/readeck.git
synced 2026-06-18 11:04:36 +00:00
Olivier Meunier
df3a0d6318
- split the massive bookmarks/routes.yaml into several files - moved big markdown contents to individual files - moved the OAuth documentation to the API description - fixed a few minor bugs with schemas - added a "data" definition to file-based import routes
1.0 KiB
1.0 KiB
Introduction
The Readeck API provides REST endpoints that can be used for any purpose, should it be a mobile application, a script, you name it.
API Endpoint
You can access this API on __BASE_URI__.
Most of your requests and responses are using JSON as the exchange format.
Test the API
On this documentation, you can test every route.
If you don't provide an API token in Authentication, you can still test all the routes but note that the given curl examples only work with an API token.
Token Authentication
If you're writing a script for yourself, the easiest way is to generate an API token that you can use using the Bearer HTTP authorization scheme.
For example, you first request will look like:
curl -H "Authorization: Bearer <TOKEN>" __BASE_URI__/profile
Or, in NodeJS:
fetch("__BASE_URI__/profile", {
headers: {
"Authorization": "Bearer <TOKEN>",
},
})