What is OpenForge?

OpenForge is an XML output from ShareSource (and other Forge's that output OpenForge XML) which allows much of the data available in ShareSource.org through a common API.

All data that is fetched from ShareSource's implementation of OpenForge is realtime. That is, as soon as a change is made in a project it will be reflected in any future requests for that project via OpenForge.

Status

OpenForge is currently in a state of still being drafted.

The implementation of ShareSource's OpenForge API is currently in beta.

Licensing Caveats

All data retrieved via ShareSource's OpenForge API belongs to the project. Other forges, however, may not follow this, and so you must check with the sites whom you use the API with.

Fetching Project Data

OpenForge Header

All replies for requests to the OpenForge API should have an API that looks like this:

<forge>
    <name>{Forge name}</name>
    <url>{Domain Name}</url>
    <version>{Forge Version}</version>
    <apiversion>{OpenForge Version}</apiversion>
</forge>

For example, ShareSource's header would look like this:

<forge>
    <name>ShareSource</name>
    <url>http://www.sharesource.org</url>
    <version>1.90.1</version>
    <apiversion>0.1</apiversion>
</forge>

The {prefix}

All requests are appended to a defualt URL. ShareSource's default URL is http://sharesource.org/api, however, other valid examples are http://api.sharesource.org and http://sourceforge.us/myapi.php. On all examples shown in this draft, it is represented as {prefix}

[optional]

Any text enclosed in square brackets are completely optional. Implementations should implement them, however, it is not necessary for them to do so. In most cases, optional text is only for presentation.

Getting 'Core' data

{prefix}/project/{project name}/[{project name}.xml]

<?xml version="1.0"?>
<reply>
    <forge>
        <name>SSDev</name>
        <url>http://ss2.timg.ws</url>
        <version>2</version>
        <apiversion>0.1</apiversion>
    </forge>

    <project>
        <unixname>sharesource</unixname>
        <title>ShareSource</title>
        <state common="stable">Stable</state>
        <downloads>0</downloads>
        
        <administrators>
            <administrator>tim</administrator>
        </administrators>
        
            
        <date-rfc>Wed, 12 Dec 07 00:00:00 +1100</date-rfc>
        <date-epoch>1197378000</date-epoch>
        <date>07-12-12, 12-00-00</date>
        
        <description>This project is SHARESOURCE :)</description>
        
        <info>
            <licenses>
                    <license common="gpl2">GNU General Public License (GPL) (v2.0)</license>
                </licenses>
            
            </info>
        
        <url>
            <home>http://sharesource.ss2.timg.ws</home>
            <description>http://ss2.timg.ws/project/sharesource/</description>
            <download>http://ss2.timg.ws/project/sharesource/files/</download>
            <wiki>http://ss2.timg.ws/project/sharesource/wiki/</wiki>
            <news>http://ss2.timg.ws/project/sharesource/news/</news>
            <screenshot>http://ss2.timg.ws/project/sharesource/screenshots/</screenshot>
            <svn>http://ss2.timg.ws/project/sharesource/repositories/</svn>
            <bug>http://ss2.timg.ws/project/sharesource/bugs/</bug>
            <todo>http://ss2.timg.ws/project/sharesource/todo/</todo>
            <lists>http://ss2.timg.ws/project/sharesource/lists/</lists>
            <l10n></l10n>
            <forum></forum>
        </url>
    </project>
</reply>