Openstore web service

The Openstore API web service gives you access to our media database and the ability to interact with Openstore from Your own apps.

The Openstore API

Openstore API has many offerings for developers, but at its core, our API lets you do all the things that Openstore users can do in the webapp. Be sure to read our Get Started Guide below.

search for api requests


How to

All available Openstore API request actions is found in the left frame

The examples uses minimal html code just to simplify understanding of calls to Openstore API.

Examples are there for You to test the actions before You implement them into Your app.

All request examples also have a "show request" function that shows the request as an url, that can be copied and used in a browser or with cURL for example.

Requests actions marked with requires logged in user session, You need to get a user from system admin, to be able to perform a successful login.

Your API url to this server is, http://demo.icemanmedia.com/OpenstoreAPI  use that url when You start programming . . .


Requests

Requests are made with HTTP POST, as example below.

http://demo.icemanmedia.com/OpenstoreAPI?action=TEST_USER_SESSION

A http POST to OpenstoreAPI with post parameter action set to TEST_USER_SESSION will respond with information about the logged in user if there is a valid session, otherwise an error response is retrieved.

You can try it here.

Note: In Safari, only the XML element text will be displayed. To view the raw XML, you must right click the page and select "View Source", in Firefox for example the response XML structure is shown directly.

Response

Respond to all calls are in XML (default) or JSON format, except for calls to receive image/object data such as jpeg images

Result of a successfully executed action starts with status Success, as shown below

XML:
<Response><status>Success</status></Response>
JSON:
{"message":"success","error_code":0,"status":"Success"}

Result of a non successfully executed action starts with error_code, as shown below

XML:

<Response><error_code>-103</error_code><error_message>No session (not logged in)</error_message></Response>

JSON:

{"message":"LoginErrorCredentials","error_code":-105,"status":"Error"}

Note: In Safari, only the XML element text will be displayed. To view the raw XML, you must right click the page and select "View Source", in Firefox for example the response XML structure is shown directly.

Get started

A good start is to check out our example source code section, read and test the examples...

Below a example of a sequence of calls to login, test user session and logout.Try them out, and if Your app can do those three calls and read the respons, then You are ready to go.