• home
• features
• case studies
• pricing & signup

Using the fluxiom API

May 02, 2007

Updated June 22, 2010, to reflect newly introduced features:

This entry is deprecated, please check out our new
fluxiom API documentation

The fluxiom API allows developers to hook into fluxiom and connect it to third-party applications.

It can be used for searching assets, retrieving assets and uploading new ones, as well as for querying metadata. Whether you’re planning on linking some internal application to fluxiom, or writing a general plugin for desktop-based software, the API can do it for you. And it’s really easy to boot!

Activating and deactivating the API

The API is strictly opt-in, and the account holder must agree to the API terms first. To enable or disable the API, simply log into your fluxiom account, and go to Account → API — only the account holder has access to this page. From there, simply follow the instructions.

Technical information

The fluxiom API is implemented via plain HTTP calls, and can generally be described as RESTful.

The basic call is an HTTP GET request, describing the type of information you require. User credentials must be sent through HTTP Basic Authentication. Secure authentication over SSL is possible if your plan supports it.

Practical introduction

We recommend using cURL for getting started and testing out the various capabilities that the API provides.

$ curl -X GET -u username:password https://account.fluxiom.com/api/assets.xml

This command issues an HTTP GET request to /api/assets.xml. If there are assets in your fluxiom account, and if the API is enabled, it will return the HTTP status code 200, and an XML document listing the assets. If nothing is found, an HTTP 404 response will be returned instead.

Please note that, while all browsers directly support the fluxiom SSL certificate, not all versions of cURL do. If yours is affected and you cannot upgrade your system, add a -k flag to the command to ignore cURL warnings about the certificate.

Available calls

Notes

Creating and updating asset data requires that you use the POST /api/upload.xml call first. Updating assets requires that your plan support versioning.

Please refer to this later post on the blog for further information.

Comments

Comments closed