PressForward API outline

[AramZS]

PressForward API Architecture

Note: Where "+" is indicated are additional API endpoints proposed to add to existing WordPress Endpoints

Note: "" indicates authentication required (optional)*

(current Zotero API read requests and sample responses, for reference)

Read

• pf/v1/item (Item endpoint data should also be added to PF driven Posts in the WPAPI)
  • /[id]/
    • Title
    • Feed ID
    • Item Date
    • Item Author
    • Item Content
    • Item Link
    • Item Feat Img
    • Item ID
    • Item Retrieved
    • Source Repeats
    • Readable Status
    • Content
    • Item Tags
    • Wordcount
    • Tags
    • Folders
    • Feed ID
  • /[id]
  • /[id]/relationships (count)
  • */[id]/relationships (full data)
  • */[id]/relationships/[user_id]
  • */[id]/comment
  • */[id]/comment/[comment_id]
  • */[id]/comment/edit/
  • /folder/[folder]
• pf/v1/nominated
  • Items+
  • Nomination Count
  • *Submitted By
  • *Nominating Users
  • Item_ID
• pf/v1/published || +posts
  • Nominated+
  • Nominated_id
  • /
• pf/v1/feed
  • /[id]/
    • Id
    • Title
    • Description
    • Type
    • feedURL
    • htmlURL
    • Module_added (string)
    • Status
    • Thumbnail
    • Parent Feed
    • *User_added
  • /[id]/alerts
    • List of alerts
  • /alerts
    • (All Feed Alerts)
    • Alert text
    • ID of Feed
    • ID of Alert
  • OPML URL
  • All PF Items Feed
• pf/v1/folders
  • ID
  • Title
  • Description
  • Slug
  • Parent
  • OPML URL
  • ...
• pf/v1/users || +Users/pf/
  • Nomination Count
  • /relationships (count)
  • */relationships (detailed objects)
• pf/v1/alerts
  • Alert text
  • Alert ID
  • Alerted Object ID
    Write
• pf/v1/item (Item endpoint data should also be added to PF driven Posts in the WPAPI)
  • PUT [id]/
  • PUT [id]/[relationship_type_id]
  • DELETE [id]
  • POST
• pf/v1/nominated
  • POST [item_id]
  • POST [object]
• pf/v1/published
• pf/v1/feed
• pf/v1/folder
• pf/v1/user
  • (nothing)
    Priorities ->
• Read
• Write (Nominate This)
• Write (Action Bar)