RSS API

INTRO

API documentation of https://foutaise.org/rss/

GET https://foutaise.org/rss/api/help

Display this API documentation.

Response

text/html

POST https://foutaise.org/rss/api/apikeys/add

Add an apikey.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Request data

apikey: string (required)

Apikey to add.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        -X POST \
        https://foutaise.org/rss/api/apikeys/add \
        -d "apikey=<apikey-to-add>"

POST https://foutaise.org/rss/api/apikeys/del

Delete an apikey.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Request data

apikey: string (required)

Apikey to delete.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        -X POST \
        https://foutaise.org/rss/api/apikeys/del \
        -d "apikey=<apikey-to-delete>"

GET https://foutaise.org/rss/api/feeds

List RSS feeds.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        id:          uint,
        link:        string,
        feedlink:    string,
        title:       string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/feeds

POST https://foutaise.org/rss/api/feeds

Add a RSS feed.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Request data

feedlink: string (required)

URL of the rss feed to add.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        -X POST \
        https://foutaise.org/rss/api/feeds \
        -d "feedlink=<new-feed-link>"

DELETE https://foutaise.org/rss/api/feeds/{id}

Delete a RSS feed.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

URI parameter

id: uint (required)

Id of the feed to delete.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        -X DELETE \
        https://foutaise.org/rss/api/feeds/{id}

GET https://foutaise.org/rss/api/feeds/refresh

Refresh RSS feeds items in the database.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        feedid:      uint,
        guid:        string,
        link:        string,
        title:       string,
        published:   string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/items/refresh

GET https://foutaise.org/rss/api/items

List unread RSS items.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Response

application/json: array of objects with the following properties

    {
        feedid:      uint,
        guid:        string,
        link:        string,
        title:       string,
        published:   string,
        description: string
    }

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/items

GET https://foutaise.org/rss/api/items/markread

Mark unread RSS items as read.

Request header

Authorization (required)

The Authorization header must start with Apikey, followed by the user's API Key.

Example

    curl -H "Authorization: Apikey <your-api-key>" \
        https://foutaise.org/rss/api/items/markread