Thursday, February 20, 2014

Autodesk Vault Programmer's Cookbook. 1.1. API structure



Navigation:


|
|

Problem

What a heck Vault API is?

Solution

What is API?

An application programming interface (API) specifies how some software components should interact with each other. (Wikipedia)

Where is API?

As Autodesk Vault SDK help kindly informs, the Vault API is:

The Web Services API comprised of the Autodesk.Connectivity.WebServices DLL.  The DLL enables you to communicate with the server.

There are several Vault editions, but API is one-for-all. How to deal with this?

When you’re communicating with server, you can use only that services, that server supports.
In 2014 Vault version there’re 3 Vault editions:
  • Basic
  • Workgroup
  • Professional
Here’s diagram that describes the functionality of API’s through them:

Where:
2 – full functionality
1 – functionality is limited
0 – N/A
I’ve created API Services Catalog in Microsoft Excel Pivot table, that could be useful for navigate through services.


What could API services do?

A lot of things – everything that Vault Client and ADMS can do, even more, because it reprezents "dogfooding" idea.

How to use API?

1. Include a link to dll in your project.
2. Connect to server, using services’ methods.
List of services method, for useful search is placed in API Services’ Methods Catalog, although in Excel Pivot Table.