Using the fluxiom API
May 02, 2007
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.xmlThis 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 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 |
*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
Comments closed
search
subscribe
e-mail newsletter
Hear about new features, updates, and more. Sent about once a month. Enter your name and email below:
subscribe
© 2005-2008 
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.
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.