Libraries and Examples

Libraries

There are no official SDKs or libraries - we believe that basic understanding of HTTP protocol is enough to efficiently use our services.

However, there are some unofficial libraries you might want to use. Many of those are currently maintained by members of the USOS Team, but we do not guarantee that all of these projects will stay alive:

  • jQuery-USOS - a set of jQuery plugins and widgets for web developers. It is being used within the USOSweb project and (as of 2014) it is in active development.

  • usosapi-python - simple Python 3 module for desktop applications. It may help with the authorization process.

If you know of any other possibly useful libraries (i.e. you've written one), let us know!

Examples

Some sample USOS API applications for you to download:

  • Hello World, written in PHP - source code on GitHub | screenshot

    A simple web application. When authorized, it retrieves user's name and some other details. It requires OAuth PHP extension to run.

  • USOS API Browser, written in C# (.NET, WPF) - source code on GitHub | screenshot | install

    Windows desktop application. It allows you to browse through USOS API methods (thanks to the apiref module) and execute them with arguments you supply.

  • Simple Proxy, written in PHP - source code on GitHub

    An USOS API proxy. It signs all requests that it receives (with a hardcoded Consumer Key), executes a given USOS API method and returns the result. Might be used in a closed, secure environment, in order to allow other applications to access USOS API methods with a simple HTTP request. It requires OAuth PHP extension to run.

  • Today's schedule, written in Python - source code | screenshot

    Simple console application. Displays today's activities (tt module). Required Python 2.6 to run (one of many Python OAuth libraries is already included).

USOS API ver. 6.1.2.0-bc1aa53 (2016-06-07)