Using the fluxiom API

May 02, 2007

http://blog.fluxiom.com/2007/5/2/using-the-fluxiom-api
by th0fu

api icon The fluxiom API allows developers to hook into fluxiom and connect it to third-party applications. It can be used for searching for assets, retrieving assets and uploading new ones, and querying metadata. Whether you’re planning on hooking some internal application into fluxiom, or writing a general plugin for desktop-based software, the API can do it for you. And it’s really easy to use to boot with!

Activating and deactivating the API

The API is strictly opt-in, and the account holder of the fluxiom account has to agree to the API terms. To enable or disable the API, and review the API terms, please go to “Account” -> “API” in your fluxiom (only the account holder has access to this page), and follow the instructions.

Technical information

The fluxiom API is implemented via plain (if you like, over “vanilla”) HTTP calls, and generally can be described as RESTful.

The basic call is HTTP GET request to a URL describing what type of information you want to query. Also, you’re required to add user credentials via HTTP Basic Authentification.

Security is provided via SSL if the plan of the fluxiom instance you query has support it. The basic and private plans only support password transmission via plain text.

Let’s get started with a basic example (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 a HTTP GET request to /api/assets.xml. If there are assets in your fluxiom account, and the API is enabled, it will return HTTP status code 200, and a XML document listing the assets.

If nothing is found, a HTTP 404 “not found” response will be returned.

(Note: While all browsers do, not all versions of cURL directly support the fluxiom SSL certificate. If that is the case add a -k flag to ignore cURL warnings about the certificate.)

Here’s a list of the various API calls available:

Object typeOperationURL
AccountList informationGET /api/account.xml
UsersList all usersGET /api/users.xml
UsersList specific userGET /api/users/id.xml
TagsList all tagsGET /api/tags.xml
AssetsList all assetsGET /api/assets.xml
AssetsSearch for termGET /api/assets.xml?query=term
AssetsSearch by tagsGET /api/assets.xml?tags=tags
AssetsInformationGET /api/assets/id.xml
AssetsDownload an assetGET /api/assets/download/id
AssetsCreate new asset*POST /api/assets.xml
AssetsUpdate asset*,**PUT /api/assets/id.xml
AssetsDelete an assetDELETE /api/assets/id.xml
UploadUpload a filePOST /api/upload.xml
AssetsAsset versionsGET /api/assets/id/versions.xml

*Creating and updating asset file data requires to use the POST /api/upload.xml call first **Updating assets requires the versioning feature, available in the pro and deluxe plans

A detailed list of API calls and return values is coming soon, stay tuned!

Do you still have questions?
Please peruse the help archives or send an email to support@fluxiom.com

Comments

by Johs on 02 May 19:19

Congratulations with your API launch!

We would hope that the thumbnail and preview images generated by Fluxiom would also be available through the API. As for user account management we would wish for this to be included in the API for better integration with other services. Alternatively, support for openID would be an alternative.

Comments closed

search

fluxiom essentials

This is the official news and support blog for fluxiom. Below you'll find a bunch of tips to get started!

get 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 Search

deliver

Share assets Create stages

tricks

How to style your descriptions Speed up! - Keyboard Shortcuts Select assets (rubberband)

administration

Involve your teammates Branding Account cancellation How to change the account holder How to upgrade/downgrade Activate the API

Still looking for help? Peruse the help archives or send an email to support@fluxiom.com

Case Studies fluxiom features fluxUp! API Get started!

subscribe

feed iconGet RSS Feed!

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: ATU62410466. Company register number: FN 276257 k. Data Protection No. DVR: 3000796
Mariahilfer Straße 113/22, A-1060 Wien, Tel.: +43 1 953 11 88, E-Mail:
All rights reserved. All trademarks and names are the property of their respective owners.