nextcloud app that replicates basic gpodder.net api
a92c0d8e71
Not necessary since Nextcloud doesn't support OCI DB |
||
---|---|---|
.github/workflows | ||
appinfo | ||
lib | ||
tests | ||
vendor | ||
.gitignore | ||
CHANGELOG.md | ||
composer.json | ||
composer.lock | ||
Makefile | ||
README.md |
nextcloud-gpodder
Nextcloud app that replicates basic gpodder.net api to sync podcast consumer apps (podcatchers) like AntennaPod.
Clients supporting sync
client | support status |
---|---|
AntennaPod | Initial purpose for this project, as a synchronization endpoint for this client. Support is available as of version 2.5.1. |
KDE Kasts | Supported since version 21.12 |
Installation
Either from the official Nextcloud app store (link to app page) or by downloading the latest release and extracting it into your Nextcloud apps/ directory.
💡 There is no app icon since there are no settings to be set.
API
subscription
- get subscription changes:
GET /index.php/apps/gpoddersync/subscriptions
- (optional) GET parameter
since
(UNIX time)
- (optional) GET parameter
- upload subscription changes :
POST /index.php/apps/gpoddersync/subscription_change/create
- returns JSON with current timestamp
The API replicates this: https://gpoddernet.readthedocs.io/en/latest/api/reference/subscriptions.html
episode action
- get episode actions:
GET /index.php/apps/gpoddersync/episode_action
- (optional) GET parameter
since
(UNIX time) - fields: podcast, episode, guid, action, timestamp, position, started, total
- (optional) GET parameter
- create episode actions:
POST /index.php/apps/gpoddersync/episode_action/create
- fields: podcast, episode, guid, action, timestamp, position, started, total
- position, started and total are optional, default value is -1
- returns JSON with current timestamp
The API replicates this: https://gpoddernet.readthedocs.io/en/latest/api/reference/events.html
we also process the property guid
Example requests:
GET /index.php/apps/gpoddersync/episode_action?since=1633240761
{
"actions": [
{
"podcast": "http://example.com/feed.rss",
"episode": "http://example.com/files/s01e20.mp3",
"guid": "s01e20-example-org",
"action": "PLAY",
"timestamp": "2009-12-12T09:00:00",
"started": 15,
"position": 120,
"total": 500
},
{
"podcast": "http://example.com/feed.rss",
"episode": "http://example.com/files/s01e20.mp3",
"guid": "s01e20-example-org",
"action": "DOWNLOAD",
"timestamp": "2009-12-12T09:00:00",
"started": -1,
"position": -1,
"total": -1
},
],
"timestamp": 12345
}
POST /index.php/apps/gpoddersync/episode_action/create
[
{
"podcast": "http://example.com/feed.rss",
"episode": "http://example.com/files/s01e20.mp3",
"guid": "s01e20-example-org",
"action": "play",
"timestamp": "2009-12-12T09:00:00",
"started": 15,
"position": 120,
"total": 500
},
{
"podcast": "http://example.org/podcast.php",
"episode": "http://ftp.example.org/foo.ogg",
"guid": "foo-bar-123",
"action": "DOWNLOAD",
"timestamp": "2009-12-12T09:05:21",
}
]