OpenAPI interface

[MC-arjen]

We will introduce new OpenAPI calls, like search, mediaItems, asset/upload (open upload).

Because of authentication and security reasons, the possibility of name conflicts, we introduce the OpenAPI interface. This needs to be implemented in a different ("openapi") Drupal module.

[Frans]

Fixed in 2.4.
See other related issues about open api

[forgacs]

Short summary about OpenAPI
===========================

Documentations for OpenAPI:

 http://opensocial-resources.googlecode.com/svn/spec/1.1/Social-API-Server.xml#MediaItems-Service
 http://opensocial-resources.googlecode.com/svn/spec/1.1/Core-API-Server.xml#Content-Upload
 http://opensocial-resources.googlecode.com/svn/spec/1.1/Social-Data.xml#Group
 http://opensocial-resources.googlecode.com/svn/spec/1.1/Social-Data.xml#MediaItem
 http://opensocial-resources.googlecode.com/svn/spec/1.1/Core-Data.xml#User-Id
 http://opensocial-resources.googlecode.com/svn/spec/1.1/Core-API-Server.xml#Standard-Request-Parameters

Prerequirements:

Openapi interface (like app1, app2, job1 etc. interfaces).
More information about the openapi interface here:
http://mediamosa.org/trac/wiki/Installing%20MediaMosa

Settings:

You can define on the configuration page (admin/mediamosa/config/global) OpenAPI part a client application for OpenAPI REST calls, and the default response type.

OpenAPI REST calls:

/openapi/search, method [GET]

 https://beheer.acceptatie.vpcore.snkn.nl/admin/mediamosa/browse/restcall/openapi-search/GET
Example call: [GET] /openapi/search?category=C1SJV9banjbSOWT4SgvjxaN5&duration=29&format=asf&publisher=pub&contributor=cont&author=creator&until=2010-08-05&since=2010-07-01&query=dc&subject=sle&language=nl&location=coverage
More documentation: TS Open Webservices - versie 0.9.pdf

OpenUpload? REST calls:

/openapi/album/$album_id [POST]
/openapi/album/$album_id/mediaitem [POST]
/openapi/album/$album_id/mediaitem/$id [POST]

Creating mediaItem (mediafile):

/openapi/mediaItem/$items_user_id/$group_id/$album_id [POST]

Getting information from mediaItems (mediafiles):

/openapi/mediaItems [GET]
/openapi/mediaItems/$items_user_id [GET]
/openapi/mediaItems/$items_user_id/$group_id [GET]
/openapi/mediaItems/$items_user_id/$group_id/$album_id [GET]
/openapi/mediaItems/$items_user_id/$group_id/$album_id/$mediaitem_id [GET]

 https://beheer.acceptatie.vpcore.snkn.nl/admin/mediamosa/browse/restcall?page=4
Example: [GET] /openapi/mediaItems/@me/@self/i1fXjdbtelVOrK7qQS1mhvNg/NgkAxZYTPmMKLETbgf1gHuJR
Where $item_user_id = @me (the current user), $group_id = @self, $album_id (asset_id) = i1fXjdbtelVOrK7qQS1mhvNg, $mediaitem_id (mediafile_id) = NgkAxZYTPmMKLETbgf1gHuJR.

[forgacs]

The openapi interface for acceptation is ready.

[forgacs]

Testing:

Check your openapi settings on the configuration page:
 https://beheer.acceptatie.vpcore.snkn.nl/admin/mediamosa/config/global

Copy - paste the OpenAPI URL ( http://openapi.***/) into your browsers.
You must see an XML response.

Set you connector like this:
* Username: Client application name of your OpenAPI client application.
* Password: Shared key of your OpenAPI client application.
* URL:  http://openapi.***/