Try Gliffy for FREE
No signup required
BETA - Please note, that the Gliffy API is currently in BETA testing. There may be minor changes to the API that are likely to occur before the product leaves BETA.
Account
An Account is the billing unit of Gliffy and the root of all requests you will make. There is a one-to-one relationship between the OAuth Consumer Key and an Account. One account may not access another account's data via the API.
If you plan to offer Gliffy to multiple customers through your Account, you should create nested folders to restrict user access. Note that only Premium accounts may create private diagrams.
Is the Account type Basic or Premium? - Currently, this isn't as straight forward as it should be. In order to determine what account type it is, you CAN NOT look at the account-type value alone. If the account-type=Basic, it's a legacy Basic account (pre December 2008), and only public diagrams may be created in this Account. As of December 2008, all new accounts start off as Premium for 30 days, and at the end of the 30 day trial period, is marked by an 'expiration-date'. Thus, if the account-type=Premium AND the expiration-date is in the past, then this Account is effectively Basic, and all new diagrams created in this account are Public. Hopefully we'll have a cleaner solution in place here soon.
Method Summary
Get account information, optionally including users in an account
Request URL
| HTTP METHOD | URL |
|---|---|
| GET or POST | $API_ROOT/accounts/$YOUR_ACCOUNT_ID.xml?action=get |
Parameters
| PARAMETER | REQUIRED | POSSIBLE VALUES | DESCRIPTION |
|---|---|---|---|
| action | Yes | get | Get the account. |
| showUsers | No | true | false | If true, the users currently provisioned in the account are returned. |
Example Response containing <accounts>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://www.gliffy.com" success="true">
<accounts>
<account max-users="10" account-type="Business" terms="true" id="101">
<name>BurnsODyne</name>
<expiration-date>32154788584000</expiration-date>
<users>
<user id="209">
<username>barney</username>
<email>barney@BurnsODyne.apiuser.gliffy.com</email>
</user>
<user id="205">
<username>bart</username>
<email>bart@BurnsODyne.apiuser.gliffy.com</email>
</user>
<user id="210">
<username>discostu</username>
<email>discostu@BurnsODyne.apiuser.gliffy.com</email>
</user>
</users>
</account>
</accounts>
</response>