In order to effectively use the SmartVault REST API, you should be familiar with the following concepts:

Account

All data is stored inside a SmartVault account. An account consists of billing information, access control, and a series of invited users. Developers will have a developer account, but they will typically be interacting with a customer’s account.

User ID

A Client ID represents a unique user in the SmartVault system. User IDs are granted specific access within one or more accounts. A User ID typically authenticates via password. However, using the SmartVault REST API, developers will use OAuth 2.0 to impersonate User IDs without requiring a password.

Client ID

A Client ID represents a specific use of the SmartVault REST API. Developers will sign up for a developer’s account and for each unique application they develop (say, an iPhone application and a web based integration), they will have one Client ID. SmartVault customers will grant specific Client IDs the ability to impersonate users within an account context.

Application

An application represents an application that stores documents within SmartVault by associating records between the native application and SmartVault. An example of an application is QuickBooks or a developer’s CRM solution. Client IDs and applications are easily confused concepts, so a simple example may help. Let’s assume as a developer you want to add document management support to your CRM solution. You have a web based interface, an iPhone application, and an Android application. You would sign up for one developer’s account, create one client ID for the CRM application, and three client IDs to represent the three different applications used to access the CRM application.