API Reference
Understanding the Union Avatars API
In this page we'll go step by step at understanding the pieces of the Union Avatars API.
To learn more about the API, you can check out: API Introduction
Authentication
In Union Avatars, the authentication can be divided in two main pilars:
Organizations​
Organizations manage the users and the content related to a Union Avatars' subscritpion. When a user logs in, it does it on behalf of an organization. The organization will determine the API limitations based on the subscription purchased.
Organizations also can manage the asset they display to their users, and even upload their own. By default, when you obtain an Organization it will contain all the assets provided by Union Avatars. Learn more here: How can I show custom outfits / filter the assets I see?
You must have an organization in order to use the Unity SDK. Get one here: Union Avatars Subscription
Users​
Users are individuals who belong to an organization. They can own and create Avatars. They authenticate by using a username and a password.
Avatars
Avatars refer to the full character that can be imported, edited,... Avatars are categorized by gender, version and style.
An avatar is always composed by an Outfit and a Head.
Assets
In Union Avatars we have 3 types of asset: Outfit, Garment and Hair.
Outfit​
Outfits are assets that, when combined with a head, create a full avatar. They can be either composed by multiple Garments, or uploaded manually from a custom file (check FAQs).
Garment​
A Garment is an individual piece of clothing that, when combined with other garments, assembles an Outfit. Garments can be one of these types: Top, Bottom, Shoes, Accessories
Hair​
A Hair that can be attached to a Head.
Asset management
Assets are linked to Catalogues, which allow for an easy query to access them.
Assets are also linked to Collections, which we use internally to categorize them by a common factor.
Catalogues​
When you obtain you organization, you will also get a Catalogue with it. Your catalogue is responsible to show the assets that your users can use on their avatars
Next steps
Now you should have a basic understanding about how the Union Avatars API operate. Check the next pages to see how you can perform all of these operation from our Unity SDK.