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
| Object type | Operation | URL |
|---|---|---|
| Account | List information | GET /api/account.xml |
| Users | List all users | GET /api/users.xml |
| Users | List specific user | GET /api/users/id.xml |
| Tags | List all tags | GET /api/tags.xml |
| Assets | List all assets | GET /api/assets.xml |
| Assets | Search for term | GET /api/assets.xml?query=term |
| Assets | Search by tags | GET /api/assets.xml?tags=tags |
| Assets | Information | GET /api/assets/id.xml |
| Assets | Download an asset | GET /api/assets/download/id |
| Assets | Create new asset | POST /api/assets.xml |
| Assets | Update asset | PUT /api/assets/id.xml |
| Assets | Delete an asset | DELETE /api/assets/id.xml |
| Upload | Upload a file | POST /api/upload.xml |
| Assets | Asset versions | GET /api/assets/id/versions.xml |
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.
Do you still have questions?Please peruse the help archives or send an email to support@fluxiom.com
Comments
Comments closed
search fluxiom help
fluxiom essentials
This is the official news and support blog for fluxiom. Below you'll find a bunch of tips to get started!
Introduction
Watch the videoGet organized
Add files (extract .zip-archives) Add files with fluxUp! Create tags About tagging, tag-set examples Get notified about new/updated assets Versioning Search and Full-Text SearchDeliver and receive files
Share files Create stages Dropbox: Replace FTPTricks
How to style your descriptions Speed up! - Keyboard Shortcuts Select assets (rubberband)Administration
Users and permissions Change your password/profile info Branding Account cancellation How to change the account holder How to upgrade/downgrade Activate the APITools & Helpers
fluxUp! uploader for Mac & PC Mac OS X widget Fluxiom and FluidStill looking for help? Peruse the help archives or send an email to support@fluxiom.com
follow us
subscribe
e-mail newsletter
Hear about new features, updates, and more. Sent about once a month. Enter your name and email below:
fluxiom is a Service of wollzelle GmbH
VAT ID: ATU64566936. Company register number: FN 319822 b. Data Protection No. DVR: 3000796
Loquaiplatz 12/12, 1060 Vienna, Austria. Tel.: +43 1 953 11 88, E-Mail:
All rights reserved. All trademarks and names are the property of their respective owners.

