API REST

The API

The API is based on the REST architecture. Main URL of the API: /webapps/uocapi/api/v1. Sandbox environment in http://oslo.uoc.es:8080/webapps/uocapi.

Security

Based on Oauth 2 with the following scopes:
  • Read(READ): The application can read data from the user.
  • Write(WRITE): The application can write data of the user.
  • Read Mail(READ_MAIL): The application can read messages of the user's personal mailbox.
  • Send Mail(SEND_MAIL): The appplication can send messages on behalf of the user.
  • Read Board Mail(READ_BOARD): The application can read messages from the communication's resources (board, debate, forum) of the classroom.
  • Send Board Mail(SEND_BOARD): The application can send messages on behalf of the user to the communication's resources (board, debate, forum) of the classroom.

Formats

Accepted formats in the API are XML and JSON.

Languages

The API is based on HTTP request, so any language that allows to perform HTTP requests can be used for your client application. You will find libraries for your favorite programming language at the Client libraries page. Currently we have libraries for C, C#, Java & Objective-C languages.

IDE

This depends on the programming language you've chosen to develop your client application. If you are developing an Android application we suggest you use Eclipse. However, if you are developing an iOS application our recommendation here is XCode. We'll post some how-to videos about setting these environments soon.