OpenEDU Syndication

Last updated on
29 May 2017

Drupal 7 will no longer be supported after January 5, 2025. Learn more and find resources for Drupal 7 sites

Description

OpenEDU Syndication is a suite of modules that allow for RSS syndication of content across multi-site installs or even multiple servers. There is also an API for non-Drupal websites to interact with the REST endpoints of the centralized Syndication server.  Content which has been authorized for syndication is delivered to registered clients upon request.  There are two components to the OpenEDU Syndication system:

Syndication Server.  A single, central Drupal installation which has enabled openedu_syndication_server module.  The syndication server acts ONLY as a reference point for syndication endpoints.  This means that the syndication server may NOT be the source of syndicated data, but it will always be the definitive source of syndication end-points within the OpenEDU ecosystem.

Syndication client.  Any system capable of reading an RSS feed.

Please note:  The Drupal instance hosting OpenEDU Syndication may be configured as both Syndication Server and Syndication Client. 

Setup a Syndication Server

Enable the OpenEDU Syndication modules. When you have enabled the appropriate modules, you should be able to see a Syndication menu item on the OpenEDU menu and be able to browse to /admin/openedu/api/syndication on your server site.

Under global settings, select the content types you want to target for syndication and whether you want end-points to use a token to authenticate themselves (more secure) or not (more open). 

These steps identify the end-point and content that may be distributed to clients.

 

Return to /admin/openedu/api/syndication and click on Server | Manage Endpoints to create the Syndication Server endpoint.  Enter the title and URL end-point from which you wish to present the syndication stream (e.g. www.example.edu). 

Register client with the Syndication server

If the client you are registering is built on OpenEDU, then it is very simple to register a client with your server. First you need your public and private key generated from your server. These can be found by browsing to "admin/openedu/syndication/server/endpoint/register".

Return to /admin/openedu/api/syndication and click on Client | Enable / Disable Content Types.  Now you may select the content types you wish this client to consume.  The choices are a bound by the syndication server's elected content types (selected above).

Now, return to /admin/openedu/api/syndication and click on Client | Register / Manage endpoint and register the client end point.

Upon completion, you will see your content at the following end-points:

http://example.edu/openedu-osc/content_type

Where content_type = news || publications || events || schools || etc...

Help improve this page

Page status: No known problems

You can: