RSS Feeds

API for managing rss feeds

List RSS Feeds

GET https://www.magloft.com/api/portal/v1/rss_feeds/:app_id

This endpoint returns a list of all RSS Feeds that belong to the publication

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.

200

{
  "id": 1234,
  "url": "https://blog.magloft.com/feed/",
  "title": "MagLoft Blog",
  "description": "MagLoft Blog Description",
  "cover": "https://mms.magloft.com/USERID/ASSETID",
  "active": true,
  "job_id": "123412341234",
  "job_status": "pending",
  "import_source": true,
  "import_author": true,
  "auto_publish": true,
  "show_related_articles": true,
  "imported_at": "2018-01-24 10:55:35",
  "created_at": "2018-01-24 10:55:35",
  "updated_at": "2018-01-24 10:55:35",
  "category_ids": [
    1,
    2,
    3
  ]
}

Create RSS Feed

POST https://www.magloft.com/api/portal/v1/rss_feeds/:app_id

This endpoint creates a new RSS Feed and returns the saved RSS Feed

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.

Request Body

Name	Type	Description
url	String	External Blog URL to import articles from
title	String	Title of the RSS Feed
import_source	Virtus::Attribute::Boolean	Boolean indicating whether the RSS Feed will import source of article
import_author	Virtus::Attribute::Boolean	Boolean indicating whether the RSS Feed will import author of article
show_related_articles	Virtus::Attribute::Boolean	Boolean indicating whether the imported article will show related articles
auto_publish	Virtus::Attribute::Boolean	Boolean indicating whether the article from the RSS Feed will be automatically published

200

{
  "id": 1234,
  "url": "https://blog.magloft.com/feed/",
  "title": "MagLoft Blog",
  "description": "MagLoft Blog Description",
  "cover": "https://mms.magloft.com/USERID/ASSETID",
  "active": true,
  "job_id": "123412341234",
  "job_status": "pending",
  "import_source": true,
  "import_author": true,
  "auto_publish": true,
  "show_related_articles": true,
  "imported_at": "2018-01-24 10:55:35",
  "created_at": "2018-01-24 10:55:35",
  "updated_at": "2018-01-24 10:55:35",
  "category_ids": [
    1,
    2,
    3
  ]
}

Get RSS Feed

GET https://www.magloft.com/api/portal/v1/rss_feeds/:app_id/:id

This endpoint returns a specific rss feed by id

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	RSS Feed ID

200

{
  "id": 1234,
  "url": "https://blog.magloft.com/feed/",
  "title": "MagLoft Blog",
  "description": "MagLoft Blog Description",
  "cover": "https://mms.magloft.com/USERID/ASSETID",
  "active": true,
  "job_id": "123412341234",
  "job_status": "pending",
  "import_source": true,
  "import_author": true,
  "auto_publish": true,
  "show_related_articles": true,
  "imported_at": "2018-01-24 10:55:35",
  "created_at": "2018-01-24 10:55:35",
  "updated_at": "2018-01-24 10:55:35",
  "category_ids": [
    1,
    2,
    3
  ]
}

Update RSS Feed

PUT https://www.magloft.com/api/portal/v1/rss_feeds/:app_id/:id

This endpoint updates a specific rss feed by id and returns the updated rss feed

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	RSS Feed ID

Request Body

Name	Type	Description
title	String	Title of the RSS Feed
description	String	Description of the RSS Feed
cover	String	Cover URL of the RSS Feed
active	Virtus::Attribute::Boolean	Boolean indicating whether the RSS Feed is currently active
import_source	Virtus::Attribute::Boolean	Boolean indicating whether the RSS Feed will import source of article
import_author	Virtus::Attribute::Boolean	Boolean indicating whether the RSS Feed will import author of article
auto_publish	Virtus::Attribute::Boolean	Boolean indicating whether the article from the RSS Feed will be automatically published
show_related_articles	Virtus::Attribute::Boolean	Boolean indicating whether the imported article will show related articles

200

{
  "id": 1234,
  "url": "https://blog.magloft.com/feed/",
  "title": "MagLoft Blog",
  "description": "MagLoft Blog Description",
  "cover": "https://mms.magloft.com/USERID/ASSETID",
  "active": true,
  "job_id": "123412341234",
  "job_status": "pending",
  "import_source": true,
  "import_author": true,
  "auto_publish": true,
  "show_related_articles": true,
  "imported_at": "2018-01-24 10:55:35",
  "created_at": "2018-01-24 10:55:35",
  "updated_at": "2018-01-24 10:55:35",
  "category_ids": [
    1,
    2,
    3
  ]
}

Delete RSS Feed

DELETE https://www.magloft.com/api/portal/v1/rss_feeds/:app_id/:id

This endpoint deletes a specific RSS Feed by id and returns an empty response with status 204

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	RSS Feed ID

200

null

Synchronize RSS Feed

POST https://www.magloft.com/api/portal/v1/rss_feeds/:app_id/:id/synchronize

This endpoint synchronizes entries from an existing RSS Feed by id and returns the synchronization results

Path Parameters

Name	Type	Description
app_id	String	App ID (Publication) to scope this request for.
id	Integer	RSS Feed ID

200

{
  "id": 1234,
  "url": "https://blog.magloft.com/feed/",
  "title": "MagLoft Blog",
  "description": "MagLoft Blog Description",
  "cover": "https://mms.magloft.com/USERID/ASSETID",
  "active": true,
  "job_id": "123412341234",
  "job_status": "pending",
  "import_source": true,
  "import_author": true,
  "auto_publish": true,
  "show_related_articles": true,
  "imported_at": "2018-01-24 10:55:35",
  "created_at": "2018-01-24 10:55:35",
  "updated_at": "2018-01-24 10:55:35",
  "category_ids": [
    1,
    2,
    3
  ]
}