API Documentation
API Documentation
Portal Login
MagLoft.com
Help Center
Portal API
Portal API
Issues
Articles
Clients
Custom Subscriptions
Readers
App Pages
RSS Import
Categories
Classifications
RSS Feeds
Powered by GitBook

RSS Feeds

API for managing rss feeds

get
List RSS Feeds

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
Request
Response
Request
Path Parameters
app_id
required
String
App ID (Publication) to scope this request for.
Response
200: OK
{
  "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
  ]
}

post
Create RSS Feed

https://www.magloft.com/api/portal/v1/rss_feeds/:app_id
This endpoint creates a new RSS Feed and returns the saved RSS Feed
Request
Response
Request
Path Parameters
app_id
required
String
App ID (Publication) to scope this request for.
Body Parameters
url
required
String
External Blog URL to import articles from
title
optional
String
Title of the RSS Feed
import_source
optional
Virtus::Attribute::Boolean
Boolean indicating whether the RSS Feed will import source of article
import_author
optional
Virtus::Attribute::Boolean
Boolean indicating whether the RSS Feed will import author of article
show_related_articles
optional
Virtus::Attribute::Boolean
Boolean indicating whether the imported article will show related articles
auto_publish
optional
Virtus::Attribute::Boolean
Boolean indicating whether the article from the RSS Feed will be automatically published
Response
200: OK
{
  "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
Get RSS Feed

https://www.magloft.com/api/portal/v1/rss_feeds/:app_id/:id
This endpoint returns a specific rss feed by id
Request
Response
Request
Path Parameters
app_id
required
String
App ID (Publication) to scope this request for.
id
required
Integer
RSS Feed ID
Response
200: OK
{
  "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
  ]
}

put
Update RSS Feed

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
Request
Response
Request
Path Parameters
app_id
required
String
App ID (Publication) to scope this request for.
id
optional
Integer
RSS Feed ID
Body Parameters
title
optional
String
Title of the RSS Feed
description
optional
String
Description of the RSS Feed
cover
optional
String
Cover URL of the RSS Feed
active
optional
Virtus::Attribute::Boolean
Boolean indicating whether the RSS Feed is currently active
import_source
optional
Virtus::Attribute::Boolean
Boolean indicating whether the RSS Feed will import source of article
import_author
optional
Virtus::Attribute::Boolean
Boolean indicating whether the RSS Feed will import author of article
auto_publish
optional
Virtus::Attribute::Boolean
Boolean indicating whether the article from the RSS Feed will be automatically published
show_related_articles
optional
Virtus::Attribute::Boolean
Boolean indicating whether the imported article will show related articles
Response
200: OK
{
  "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
Delete RSS Feed

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
Request
Response
Request
Path Parameters
app_id
required
String
App ID (Publication) to scope this request for.
id
required
Integer
RSS Feed ID
Response
200: OK
null

post
Synchronize RSS Feed

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
Request
Response
Request
Path Parameters
app_id
required
String
App ID (Publication) to scope this request for.
id
required
Integer
RSS Feed ID
Response
200: OK
{
  "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
  ]
}
Portal API - Previous
Classifications
Last updated 4 weeks ago
Contents
get
List RSS Feeds
post
Create RSS Feed
get
Get RSS Feed
put
Update RSS Feed
delete
Delete RSS Feed
post
Synchronize RSS Feed