Integration Capabilities (data and UI) of Open vs Non-Open edX

[Steven Brent]

Hello! I work at a SAAS vendor, and we are looking into the options for integration with our s/gamification/digital motivation platform on behalf of a client.

I understand that Open edX provides extensive APIs for integration; what I am wondering about is the extent of these capabilities within the non-open platform. Specifically, the automation of data export (reporting / analytics) as well as the possibilities for embedding our (JavaScript-based) widgets within a custom page in the edX environment.

Can you please help me get my head around this? Thanks very much!

[David Baumgold]

Most of the repositories that comprise the Open edX project are licensed under the AGPL license, while a few are licensed under the Apache 2.0 license. I am not a lawyer, so I am not qualified to give legal advice. With that said, the short answer to your question is, you may use non-open software in conjunction with the Open edX software, as long as you meet the following requirements:

* The non-open software only interacts with the Open edX software through a clean API, such that it's possible to swap out Open edX with some other piece of software that provides the same API. This strict separation proves that your software is not part of Open edX, and therefore is not required to use the AGPL license.

* You continue to abide by the terms of the AGPL as it applies to the Open edX software. For example, you will need to run the Open edX codebase in order to use the APIs that it exposes from your non-open software. If you make any changes to your local copy of the Open edX software, you still must release those changes under the AGPL as well, and make them freely available to anyone who uses your software.

I should point out that this only applies to the repositories that are AGPL-licensed. The Apache 2.0 license is a more permissive license, which does not require you to make your modifications open source. For example, the XBlock repository is licensed under the Apache 2.0 license, so if you want to fork that repository, make changes, and keep your changes closed-source, you are free to do so. It also means you are allowed to make custom XBlocks that are closed-source.

Does that answer your question? If you need further clarification, ask away! I believe that there are also several companies that are already doing things similar to what you want to do -- perhaps someone from one of those companies can reply, as well.

David Baumgold

Developer Advocate, edX

[Steven Brent]

Thanks for the response, David. The licensing terms info is definitely useful, but what I am looking for is an understanding of the technical capabilities of the closed platform vs Open edX for integration with 3rd party platforms. Best, Steven

[David Baumgold]

So, you're looking for information about the extension points in Open edX? We have some documentation that covers that. Or are you looking for something different? You talk about "the closed platform", and I'm not sure exactly what you're referring to. Open edX is open. :)

DB

[Steven Brent]

I'm looking to do a comparison between the 3rd party integration capabilities of Open edX vs edX. Thanks.

[Ned Batchelder]

Steven,

The code on the "closed" edx.org is the same code as in Open edX.  We don't think of edx.org as "the closed edX", it's just another instance of Open edX.  There may be features turned on or off differently on edx.org than in other installations, but the basic capabilities are the same.  

Also, the set of non-core XBlocks running on any Open edX server will differ, but I don't get the sense that you are looking for particular XBlocks.

Course authors can make use of Javascript components in their courses, that is up to the course teams.

Does that help?

--Ned.

[Steven Brent]

Thanks, Ned - so I am I correct in thinking that the use case for Open edX is to allow people to host their own edX platforms and customize if needed?

[Molly de Blanc]

Exactly. Open edX allows people to host their own platform and customize it as needed. There are some good examples of things people have done with the platform on https://github.com/edx/edx-platform/wiki/Sites-powered-by-Open-edX.

Cheers,

Molly

--

Molly de Blanc
Community Coordinator

Open edX

141 Portland St, Cambridge, MA 02139

[Steven Brent]

Molly, thank you. One last question, and then I think you all will have dragged me across the line successfully :-D

Does edX.org provide the same APIs for fetching user activity as are documented for Open EdX? I'm investigating whether it would be possible, using a 3rd party system, to access the Data Analytics API (get weekly user activity, etc) on edX.org, *not* from a self-hosted Open edX instance.

[Brian Wilson]

There is a data analytics API on edx.org that provides information for course instructors and staff that they can view at insights.edx.org.  However, this API is protected, since the information itself is not meant for general access.  At some point in the future, we hope to make access to this API available, but it would require the same kind of authentication that insights currently uses.  But then at least a course staff user could access data about their course through the API, rather than only through Insights.

= Brian =

[Steven Brent]

Thanks! The Data Analytics API is good stuff, and exactly what is needed in this case.

The happy news I just got is that it turns out the client is hosting their own Open edX instance, so the possibilities are pretty exciting.

Best, SB

[Ned Batchelder]

Steven, good to hear you can see the road ahead.  When you have a site launched, be sure to let us know about it.  You can add it to the wiki page Molly linked.

--Ned.