API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API

See imageloop API in action in our Showcase !

This page gives an overview of the imageloop API. All API calls do only use standard HTTP requests to our imageloop server via TCP port 80. This means, that your applications work, if your browser can access imageloop. Standards like HTTP, XML and SOAP guarantee fexibility and fit into existing network infrastructures.

Developers will find information and tools to build their own applications using imageloooop. imageloop offers its API and language kits for several programming languages like JavaScript, PHP, ActionScript, Java, C# or VB.NET.

An API key is required to use the imageloop API or a language kit. There are two different kinds of API keys:

  1. API keys for applications running on web pages inside a browser (JavaScript) and
  2. API keys for standalone applications (Java, PHP, C#, VB.NET, ActionScript)

Language Kits

Ready to use libraries for these programming languages are available from imageloop or a 3rd party.

Java (Javadoc) Java language support library using the SOAP transport for integration into your Java applications.
PHP PHP language support library using both HTTP-RPC and SOAP transport for integration into your PHP applications.
JavaScript / HTTP-Client JavaScript language support library using the HTTP-Client transport for integration into your web pages.
.NET / SOAP Microsoft .NET support library using the SOAP transport for integration into your .NET applications written in Managed C++, C#, Visual Basic .NET or J#.
ActionScript (Macromedia Flash) / HTTP-RPC ActionScript language support library using the HTTP-RPC transport for integration into your web pages.

Transports

imageloop API supports several transportation mechanisms. All transportation mechanisms support the same functionality and require HTTP session tracking using a cookie (see below).

SOAP RPC style SOAP transport function calls.

Take a look at this page for more information about SOAP transport.

WSDL file can be downlaoded from http://www.imageloop.com/soap/api/api.wsdl, which referes to the XSD file http://www.imageloop.com/soap/api/api.xsd.

HTTP-RPC URL encoded function calls with XML responses used in applications. The browser session is either tracked by a HTTP session cookie or the application sends the session ID as a URL suffix.

Take a look at this page for more information about XML schema objects.

HTTP-Client URL encoded function calls with XML responses used in interactive web pages. Requires the browser to support HTTP session cookies. A URL parameter specifies the XML stylesheet returns used by the browser to render the XML to valid HTML usable by human being.

HTTP session

Please note, that most functions (especially when a login is required) rely on working HTTP session handling.

HTTP session handling in imageloop is implemented using a session cookie named JSESSIONID. This value of this cookie is the ID of the current HTTP session.

Usually all common SOAP client implementations support HTTP cookie tracking. The language kits for Java and .NET use functionality provided by the frameworks. Our JavaScript language kit "uses" the functionality provided by browsers.

You can test, whether your framework provides working HTTP cookie handling by calling the API function imageloop.getSessionId twice. If the same value is returned by both calls, HTTP cookies work. If two different values are returned, your framework does not provide a working HTTP session tracking. In this case, you have to implement your own session tracking.

To implement your own session tracking, you can do either:

  • Wait for the HTTP header Set-Cookie and pass the cookie value in all following requests to our application in the HTTP Cookie header.
  • Or you can query the session ID using the API method imageloop.getSessionId and pass this value in all following requests to our application in the HTTP Cookie header.
  • Note: the HTTP session ID changes when a user logs in or logs out!

List of all API functions

Image functions

Image maintenance

imagelooop.deleteImage

Image meta data

imagelooop.getImageMetaData
imagelooop.getImageViews
imagelooop.setImageCoordinates
imagelooop.setImageMetaData
imagelooop.setImageOrder

Image queries

imagelooop.getImageByPermalink
imagelooop.getRandomImages
imagelooop.getRandomImagesEx

Upload

imagelooop.uploadData
imagelooop.uploadFilesForm

Import and export

Import

imagelooop.importContent
imagelooop.importLooop

Myspace profile

imagelooop.exportLooopMyspace
imagelooop.setupMyspaceGuestbook
imagelooop.setupMyspaceProfile

Invitations

imagelooop.sendImage
imagelooop.sendInvitation
imagelooop.sendLooop

Layout

imagelooop.getPlayerDefinitions
imagelooop.getSkinCategories

Login functions

imagelooop.getCurrentUserInfo
imagelooop.getCurrentUserName
imagelooop.login
imagelooop.logoff

looop functions

looop content

imagelooop.getLooopImages
imagelooop.getLooopImagesEx

looop creation & deletion

imagelooop.createExternalSourceLooop
imagelooop.createLooop
imagelooop.deleteLooop
imagelooop.disableExternalSourceLooop
imagelooop.makeExternalSourceLooop
imagelooop.publishLooop
imagelooop.updateExternalSourceLooop

looop meta data

imagelooop.getLooopExternalSource
imagelooop.getLooopMetaData
imagelooop.getLooopMetaDataEx
imagelooop.getLooopViews
imagelooop.setLooopCoordinates
imagelooop.setLooopMetaData
imagelooop.updateLooopExternalSource

looop player

imagelooop.getLooopPlayerExportHtml

looop player setup

imagelooop.getLooopPlayerConfig
imagelooop.setLooopPlayerConfig

looop queries

imagelooop.getLooop
imagelooop.getLooopByPermalink
imagelooop.getLooopByPermalinkEx
imagelooop.getLooopEx
imagelooop.getMyLooops
imagelooop.getMyLooopsEx
imagelooop.getRandomLooops
imagelooop.getRandomLooopsEx
imagelooop.getSimilarLooops
imagelooop.getSimilarLooopsEx
imagelooop.getSubscribedLooops
imagelooop.getSubscribedLooopsEx
imagelooop.getUserPublicLooops
imagelooop.getUserPublicLooopsEx

looop security

imagelooop.addLooopPermittedUser
imagelooop.getLooopPermittedUsers
imagelooop.removeLooopPermittedUser

looop subscriptions

imagelooop.getLooopSubscribers
imagelooop.getMySubscriptions
imagelooop.subscribeLooop
imagelooop.unsubscribeLooop

Misc. functions

imagelooop.getAvailableRenditions

Query functions

imagelooop.queryImages
imagelooop.queryImagesEx
imagelooop.queryLooops
imagelooop.queryLooopsEx

rating functions

image rating

imagelooop.imageRating

looop rating

imagelooop.looopRating

special functions

remote registration

imagelooop.canRegisterUsers
imagelooop.impersonateAsUser
imagelooop.joinUser
imagelooop.registerUser
imagelooop.validUsername

Test functions

imagelooop.getSessionId
imagelooop.ping

user functions

comments

imagelooop.addComment
imagelooop.getComments

contacts

imagelooop.addContact
imagelooop.removeContact

user queries

imagelooop.getUserById
imagelooop.getUserByName